> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mygigsters.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create connected account

> Onboards and registers a connected client account under the authenticated partner. Automatically generates a unique client UUID (account_id) and a secure, time-sensitive KYC magic link (kyc_magic_link) for direct customer verification.

### Headers

**x-api-version** `string` *required*

Target API version (e.g. `1.2`).

### Request Body Parameters

**legal\_entity\_type** `string` *required*

Legal entity type of the client. Allowed values: `BUSINESS`, `INDIVIDUAL`.

**business\_name** `string`

Registered trade name or company name. Required if `legalEntityType` is `BUSINESS`.

**full\_name** `string` *required*

Full legal name of the primary contact person or authorized representative.

**email** `string` *required*

Primary contact and administrative email for the client connected account.

**phone** `string` *required*

Primary contact phone number (e.g. `+61412340918`).

**abn** `string`

11-digit Australian Business Number (e.g. `99 687 807 763`). Required if entity is a registered Australian business.

**addrline1** `string` *required*

Street address line 1 (e.g. `123 Collins St`).

**suburb** `string` *required*

Suburb, locality, or town (e.g. `Melbourne`).

**state** `string` *required*

State or territory code (e.g. `VIC`, `NSW`, `QLD`).

**postcode** `string` *required*

Postal code (e.g. `3000`).

**country\_code** `string` *required*

Two-letter ISO 3166-1 alpha-2 country code (e.g. `AU`).

### Response Body

**message** `string`

Status message (e.g. `Signup successful`).

**account\_id** `string`

The unique UUID identifier assigned to the connected account in MyGigsters.

**kyc\_magic\_link** `string`

Secure, pre-authenticated onboarding URL. Send or redirect your client to this magic link so they can complete identity verification and KYC checks.

### Response Codes

| Code | Description |
| - | - |
| 200 / 201 | Signup successful. Client created and KYC link generated. |
| 400 | Bad Request. Missing required registration fields or invalid format. |
| 401 | Unauthorized. Missing, expired, or invalid partner Bearer token. |
| 409 | Conflict. An account with this email or ABN already exists. |
| 500 | Internal Server Error. An unexpected error occurred on the server. |

```bash cURL theme={null}
curl -X POST https://qa-payments.mygigsters.com.au/api/v1/connected-account \
  -H "Content-Type: application/json" \
  -H "X-API-Version: 1.2" \
  -H "Authorization: Bearer <accessToken>" \
  -d '{
  "legal_entity_type": "BUSINESS",
  "business_name": "Parle Business Pty Ltd",
  "full_name": "Jane Client",
  "email": "parle+1@example.com",
  "phone": "+61412340918",
  "abn": "99 687 807 763",
  "addrline1": "123 Collins St",
  "suburb": "Melbourne",
  "state": "VIC",
  "postcode": "3000",
  "country_code": "AU"
}'
```

```javascript Node.js theme={null}
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/connected-account", {
  method: "POST",
  headers: {
    Authorization: "Bearer <accessToken>",
    "Content-Type": "application/json",
    "X-API-Version": "1.2",
  },
  body: JSON.stringify({
    "legal_entity_type": "BUSINESS",
    "business_name": "Parle Business Pty Ltd",
    "full_name": "Jane Client",
    "email": "parle+1@example.com",
    "phone": "+61412340918",
    "abn": "99 687 807 763",
    "addrline1": "123 Collins St",
    "suburb": "Melbourne",
    "state": "VIC",
    "postcode": "3000",
    "country_code": "AU"
  }),
});

const data = await response.json();
console.log(data);
```

```python Python theme={null}
import requests

response = requests.post(
    "https://qa-payments.mygigsters.com.au/api/v1/connected-account",
    headers={
        "Authorization": "Bearer <accessToken>",
        "X-API-Version": "1.2",
    },
    json={
        "legal_entity_type": "BUSINESS",
        "business_name": "Parle Business Pty Ltd",
        "full_name": "Jane Client",
        "email": "parle+1@example.com",
        "phone": "+61412340918",
        "abn": "99 687 807 763",
        "addrline1": "123 Collins St",
        "suburb": "Melbourne",
        "state": "VIC",
        "postcode": "3000",
        "country_code": "AU",
    },
)

print(response.json())
```

```ruby Ruby theme={null}
require "net/http"
require "json"
require "uri"

uri = URI("https://qa-payments.mygigsters.com.au/api/v1/connected-account")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <accessToken>"
request["Content-Type"] = "application/json"
request["X-API-Version"] = "1.2"
request.body = <<~JSON
  {
    "legal_entity_type": "BUSINESS",
    "business_name": "Parle Business Pty Ltd",
    "full_name": "Jane Client",
    "email": "parle+1@example.com",
    "phone": "+61412340918",
    "abn": "99 687 807 763",
    "addrline1": "123 Collins St",
    "suburb": "Melbourne",
    "state": "VIC",
    "postcode": "3000",
    "country_code": "AU"
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts JSON.parse(response.body)
```

```php PHP theme={null}
<?php

$ch = curl_init("https://qa-payments.mygigsters.com.au/api/v1/connected-account");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer <accessToken>",
        "Content-Type: application/json",
        "X-API-Version: 1.2",
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
{
  "legal_entity_type": "BUSINESS",
  "business_name": "Parle Business Pty Ltd",
  "full_name": "Jane Client",
  "email": "parle+1@example.com",
  "phone": "+61412340918",
  "abn": "99 687 807 763",
  "addrline1": "123 Collins St",
  "suburb": "Melbourne",
  "state": "VIC",
  "postcode": "3000",
  "country_code": "AU"
}
JSON,
]);

$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));
```

```java Java theme={null}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = String.join("\n",
            "{",
            "  \"legal_entity_type\": \"BUSINESS\",",
            "  \"business_name\": \"Parle Business Pty Ltd\",",
            "  \"full_name\": \"Jane Client\",",
            "  \"email\": \"parle+1@example.com\",",
            "  \"phone\": \"+61412340918\",",
            "  \"abn\": \"99 687 807 763\",",
            "  \"addrline1\": \"123 Collins St\",",
            "  \"suburb\": \"Melbourne\",",
            "  \"state\": \"VIC\",",
            "  \"postcode\": \"3000\",",
            "  \"country_code\": \"AU\"",
            "}"
        );

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/connected-account"))
            .header("Authorization", "Bearer <accessToken>")
            .header("Content-Type", "application/json")
            .header("X-API-Version", "1.2")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
```

```go Go theme={null}
package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "legal_entity_type": "BUSINESS",
  "business_name": "Parle Business Pty Ltd",
  "full_name": "Jane Client",
  "email": "parle+1@example.com",
  "phone": "+61412340918",
  "abn": "99 687 807 763",
  "addrline1": "123 Collins St",
  "suburb": "Melbourne",
  "state": "VIC",
  "postcode": "3000",
  "country_code": "AU"
}`)

	req, err := http.NewRequest("POST", "https://qa-payments.mygigsters.com.au/api/v1/connected-account", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <accessToken>")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-API-Version", "1.2")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}
```

```csharp .NET theme={null}
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://qa-payments.mygigsters.com.au/api/v1/connected-account");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<accessToken>");
request.Headers.Add("X-API-Version", "1.2");
request.Content = new StringContent(@"{
  ""legal_entity_type"": ""BUSINESS"",
  ""business_name"": ""Parle Business Pty Ltd"",
  ""full_name"": ""Jane Client"",
  ""email"": ""parle+1@example.com"",
  ""phone"": ""+61412340918"",
  ""abn"": ""99 687 807 763"",
  ""addrline1"": ""123 Collins St"",
  ""suburb"": ""Melbourne"",
  ""state"": ""VIC"",
  ""postcode"": ""3000"",
  ""country_code"": ""AU""
}", Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

```json Response theme={null}
{
  "message": "Signup successful",
  "account_id": "f57ddb6d-c55d-44a6-a98a-2dbef12278a0",
  "kyc_magic_link": "http://localhost: 3000/client/kyc/eyJhbGciOiJSUzI1NiIs..."
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.