Create a customer

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.13/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "type": "individual",
  "companyLegalName": "<string>",
  "firstName": "Jane",
  "middleName": "<string>",
  "lastName": "Smith",
  "email": "jane@example.com",
  "phone": "+12125551234",
  "birthDate": "1990-05-15",
  "nationality": "US",
  "ipAddress": "<string>",
  "externalId": "usr_12345",
  "signedAgreement": false,
  "residentialAddress": {
    "line1": "123 Main St",
    "line2": "<string>",
    "city": "New York",
    "state": "NY",
    "country": "US",
    "zipCode": "10001"
  },
  "identifyingInformation": [
    {
      "type": "ssn",
      "issuingCountry": "US",
      "number": "123456789"
    }
  ],
  "endorsements": [],
  "metadata": {}
}
'

import requests

url = "https://sandbox-api.polygon.technology/v0.13/customers"

payload = {
    "type": "individual",
    "companyLegalName": "<string>",
    "firstName": "Jane",
    "middleName": "<string>",
    "lastName": "Smith",
    "email": "jane@example.com",
    "phone": "+12125551234",
    "birthDate": "1990-05-15",
    "nationality": "US",
    "ipAddress": "<string>",
    "externalId": "usr_12345",
    "signedAgreement": False,
    "residentialAddress": {
        "line1": "123 Main St",
        "line2": "<string>",
        "city": "New York",
        "state": "NY",
        "country": "US",
        "zipCode": "10001"
    },
    "identifyingInformation": [
        {
            "type": "ssn",
            "issuingCountry": "US",
            "number": "123456789"
        }
    ],
    "endorsements": [],
    "metadata": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'individual',
    companyLegalName: '<string>',
    firstName: 'Jane',
    middleName: '<string>',
    lastName: 'Smith',
    email: 'jane@example.com',
    phone: '+12125551234',
    birthDate: '1990-05-15',
    nationality: 'US',
    ipAddress: '<string>',
    externalId: 'usr_12345',
    signedAgreement: false,
    residentialAddress: {
      line1: '123 Main St',
      line2: '<string>',
      city: 'New York',
      state: 'NY',
      country: 'US',
      zipCode: '10001'
    },
    identifyingInformation: [{type: 'ssn', issuingCountry: 'US', number: '123456789'}],
    endorsements: [],
    metadata: {}
  })
};

fetch('https://sandbox-api.polygon.technology/v0.13/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.13/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'individual',
    'companyLegalName' => '<string>',
    'firstName' => 'Jane',
    'middleName' => '<string>',
    'lastName' => 'Smith',
    'email' => 'jane@example.com',
    'phone' => '+12125551234',
    'birthDate' => '1990-05-15',
    'nationality' => 'US',
    'ipAddress' => '<string>',
    'externalId' => 'usr_12345',
    'signedAgreement' => false,
    'residentialAddress' => [
        'line1' => '123 Main St',
        'line2' => '<string>',
        'city' => 'New York',
        'state' => 'NY',
        'country' => 'US',
        'zipCode' => '10001'
    ],
    'identifyingInformation' => [
        [
                'type' => 'ssn',
                'issuingCountry' => 'US',
                'number' => '123456789'
        ]
    ],
    'endorsements' => [
        
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://sandbox-api.polygon.technology/v0.13/customers"

	payload := strings.NewReader("{\n  \"type\": \"individual\",\n  \"companyLegalName\": \"<string>\",\n  \"firstName\": \"Jane\",\n  \"middleName\": \"<string>\",\n  \"lastName\": \"Smith\",\n  \"email\": \"jane@example.com\",\n  \"phone\": \"+12125551234\",\n  \"birthDate\": \"1990-05-15\",\n  \"nationality\": \"US\",\n  \"ipAddress\": \"<string>\",\n  \"externalId\": \"usr_12345\",\n  \"signedAgreement\": false,\n  \"residentialAddress\": {\n    \"line1\": \"123 Main St\",\n    \"line2\": \"<string>\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"country\": \"US\",\n    \"zipCode\": \"10001\"\n  },\n  \"identifyingInformation\": [\n    {\n      \"type\": \"ssn\",\n      \"issuingCountry\": \"US\",\n      \"number\": \"123456789\"\n    }\n  ],\n  \"endorsements\": [],\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.polygon.technology/v0.13/customers")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"individual\",\n  \"companyLegalName\": \"<string>\",\n  \"firstName\": \"Jane\",\n  \"middleName\": \"<string>\",\n  \"lastName\": \"Smith\",\n  \"email\": \"jane@example.com\",\n  \"phone\": \"+12125551234\",\n  \"birthDate\": \"1990-05-15\",\n  \"nationality\": \"US\",\n  \"ipAddress\": \"<string>\",\n  \"externalId\": \"usr_12345\",\n  \"signedAgreement\": false,\n  \"residentialAddress\": {\n    \"line1\": \"123 Main St\",\n    \"line2\": \"<string>\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"country\": \"US\",\n    \"zipCode\": \"10001\"\n  },\n  \"identifyingInformation\": [\n    {\n      \"type\": \"ssn\",\n      \"issuingCountry\": \"US\",\n      \"number\": \"123456789\"\n    }\n  ],\n  \"endorsements\": [],\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.13/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"individual\",\n  \"companyLegalName\": \"<string>\",\n  \"firstName\": \"Jane\",\n  \"middleName\": \"<string>\",\n  \"lastName\": \"Smith\",\n  \"email\": \"jane@example.com\",\n  \"phone\": \"+12125551234\",\n  \"birthDate\": \"1990-05-15\",\n  \"nationality\": \"US\",\n  \"ipAddress\": \"<string>\",\n  \"externalId\": \"usr_12345\",\n  \"signedAgreement\": false,\n  \"residentialAddress\": {\n    \"line1\": \"123 Main St\",\n    \"line2\": \"<string>\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"country\": \"US\",\n    \"zipCode\": \"10001\"\n  },\n  \"identifyingInformation\": [\n    {\n      \"type\": \"ssn\",\n      \"issuingCountry\": \"US\",\n      \"number\": \"123456789\"\n    }\n  ],\n  \"endorsements\": [],\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "cst_01H9Xa8F5dN6mP3q",
  "type": "individual",
  "name": "Jane Smith",
  "firstName": "Jane",
  "middleName": null,
  "lastName": "Smith",
  "email": "jane@example.com",
  "phone": "+12125551234",
  "nationality": "US",
  "externalId": "usr_12345",
  "status": "active",
  "hold": {
    "code": "verificationRequired",
    "message": "<string>"
  },
  "failure": {
    "code": "onboardingRejected",
    "message": "<string>",
    "retryable": true
  },
  "signedAgreement": true,
  "signedAgreementAt": "2026-03-20T14:15:22Z",
  "totalBalance": {
    "totalUsd": "1250.00",
    "fiatUsd": "1000.00",
    "cryptoUsd": "250.00"
  },
  "wallets": [
    {
      "id": "wlt_01H9Xb3K7nM2pQ4r",
      "type": "custodial",
      "address": "0x7B3a9F2c4D1eA8bF6390cE5d2B7fA104C8e3D9b1",
      "network": "polygon",
      "asset": "usdc",
      "balance": "1234.56",
      "estimatedValueUsd": "1234.56",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "endorsements": [
    {
      "type": "basic",
      "status": "pending",
      "requirements": {
        "complete": [
          "<string>"
        ],
        "pending": [
          "<string>"
        ],
        "missing": [
          "<string>"
        ],
        "issues": [
          "<string>"
        ]
      },
      "failure": {
        "code": "onboardingRejected",
        "message": "<string>",
        "retryable": true
      }
    }
  ],
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "id": "cst_01H9Xa8F5dN6mP3q",
  "object": "customer",
  "status": "processing"
}

{
  "error": "Unauthorized",
  "code": 1000,
  "msg": "unauthorized access",
  "status": 401,
  "cause": "signature"
}

{
  "error": "Unauthorized",
  "code": 1000,
  "msg": "unauthorized access",
  "status": 401,
  "cause": "signature"
}

POST

customers

Create a customer

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.13/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "type": "individual",
  "companyLegalName": "<string>",
  "firstName": "Jane",
  "middleName": "<string>",
  "lastName": "Smith",
  "email": "jane@example.com",
  "phone": "+12125551234",
  "birthDate": "1990-05-15",
  "nationality": "US",
  "ipAddress": "<string>",
  "externalId": "usr_12345",
  "signedAgreement": false,
  "residentialAddress": {
    "line1": "123 Main St",
    "line2": "<string>",
    "city": "New York",
    "state": "NY",
    "country": "US",
    "zipCode": "10001"
  },
  "identifyingInformation": [
    {
      "type": "ssn",
      "issuingCountry": "US",
      "number": "123456789"
    }
  ],
  "endorsements": [],
  "metadata": {}
}
'

import requests

url = "https://sandbox-api.polygon.technology/v0.13/customers"

payload = {
    "type": "individual",
    "companyLegalName": "<string>",
    "firstName": "Jane",
    "middleName": "<string>",
    "lastName": "Smith",
    "email": "jane@example.com",
    "phone": "+12125551234",
    "birthDate": "1990-05-15",
    "nationality": "US",
    "ipAddress": "<string>",
    "externalId": "usr_12345",
    "signedAgreement": False,
    "residentialAddress": {
        "line1": "123 Main St",
        "line2": "<string>",
        "city": "New York",
        "state": "NY",
        "country": "US",
        "zipCode": "10001"
    },
    "identifyingInformation": [
        {
            "type": "ssn",
            "issuingCountry": "US",
            "number": "123456789"
        }
    ],
    "endorsements": [],
    "metadata": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'individual',
    companyLegalName: '<string>',
    firstName: 'Jane',
    middleName: '<string>',
    lastName: 'Smith',
    email: 'jane@example.com',
    phone: '+12125551234',
    birthDate: '1990-05-15',
    nationality: 'US',
    ipAddress: '<string>',
    externalId: 'usr_12345',
    signedAgreement: false,
    residentialAddress: {
      line1: '123 Main St',
      line2: '<string>',
      city: 'New York',
      state: 'NY',
      country: 'US',
      zipCode: '10001'
    },
    identifyingInformation: [{type: 'ssn', issuingCountry: 'US', number: '123456789'}],
    endorsements: [],
    metadata: {}
  })
};

fetch('https://sandbox-api.polygon.technology/v0.13/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.13/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'individual',
    'companyLegalName' => '<string>',
    'firstName' => 'Jane',
    'middleName' => '<string>',
    'lastName' => 'Smith',
    'email' => 'jane@example.com',
    'phone' => '+12125551234',
    'birthDate' => '1990-05-15',
    'nationality' => 'US',
    'ipAddress' => '<string>',
    'externalId' => 'usr_12345',
    'signedAgreement' => false,
    'residentialAddress' => [
        'line1' => '123 Main St',
        'line2' => '<string>',
        'city' => 'New York',
        'state' => 'NY',
        'country' => 'US',
        'zipCode' => '10001'
    ],
    'identifyingInformation' => [
        [
                'type' => 'ssn',
                'issuingCountry' => 'US',
                'number' => '123456789'
        ]
    ],
    'endorsements' => [
        
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://sandbox-api.polygon.technology/v0.13/customers"

	payload := strings.NewReader("{\n  \"type\": \"individual\",\n  \"companyLegalName\": \"<string>\",\n  \"firstName\": \"Jane\",\n  \"middleName\": \"<string>\",\n  \"lastName\": \"Smith\",\n  \"email\": \"jane@example.com\",\n  \"phone\": \"+12125551234\",\n  \"birthDate\": \"1990-05-15\",\n  \"nationality\": \"US\",\n  \"ipAddress\": \"<string>\",\n  \"externalId\": \"usr_12345\",\n  \"signedAgreement\": false,\n  \"residentialAddress\": {\n    \"line1\": \"123 Main St\",\n    \"line2\": \"<string>\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"country\": \"US\",\n    \"zipCode\": \"10001\"\n  },\n  \"identifyingInformation\": [\n    {\n      \"type\": \"ssn\",\n      \"issuingCountry\": \"US\",\n      \"number\": \"123456789\"\n    }\n  ],\n  \"endorsements\": [],\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.polygon.technology/v0.13/customers")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"individual\",\n  \"companyLegalName\": \"<string>\",\n  \"firstName\": \"Jane\",\n  \"middleName\": \"<string>\",\n  \"lastName\": \"Smith\",\n  \"email\": \"jane@example.com\",\n  \"phone\": \"+12125551234\",\n  \"birthDate\": \"1990-05-15\",\n  \"nationality\": \"US\",\n  \"ipAddress\": \"<string>\",\n  \"externalId\": \"usr_12345\",\n  \"signedAgreement\": false,\n  \"residentialAddress\": {\n    \"line1\": \"123 Main St\",\n    \"line2\": \"<string>\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"country\": \"US\",\n    \"zipCode\": \"10001\"\n  },\n  \"identifyingInformation\": [\n    {\n      \"type\": \"ssn\",\n      \"issuingCountry\": \"US\",\n      \"number\": \"123456789\"\n    }\n  ],\n  \"endorsements\": [],\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.13/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"individual\",\n  \"companyLegalName\": \"<string>\",\n  \"firstName\": \"Jane\",\n  \"middleName\": \"<string>\",\n  \"lastName\": \"Smith\",\n  \"email\": \"jane@example.com\",\n  \"phone\": \"+12125551234\",\n  \"birthDate\": \"1990-05-15\",\n  \"nationality\": \"US\",\n  \"ipAddress\": \"<string>\",\n  \"externalId\": \"usr_12345\",\n  \"signedAgreement\": false,\n  \"residentialAddress\": {\n    \"line1\": \"123 Main St\",\n    \"line2\": \"<string>\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"country\": \"US\",\n    \"zipCode\": \"10001\"\n  },\n  \"identifyingInformation\": [\n    {\n      \"type\": \"ssn\",\n      \"issuingCountry\": \"US\",\n      \"number\": \"123456789\"\n    }\n  ],\n  \"endorsements\": [],\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "cst_01H9Xa8F5dN6mP3q",
  "type": "individual",
  "name": "Jane Smith",
  "firstName": "Jane",
  "middleName": null,
  "lastName": "Smith",
  "email": "jane@example.com",
  "phone": "+12125551234",
  "nationality": "US",
  "externalId": "usr_12345",
  "status": "active",
  "hold": {
    "code": "verificationRequired",
    "message": "<string>"
  },
  "failure": {
    "code": "onboardingRejected",
    "message": "<string>",
    "retryable": true
  },
  "signedAgreement": true,
  "signedAgreementAt": "2026-03-20T14:15:22Z",
  "totalBalance": {
    "totalUsd": "1250.00",
    "fiatUsd": "1000.00",
    "cryptoUsd": "250.00"
  },
  "wallets": [
    {
      "id": "wlt_01H9Xb3K7nM2pQ4r",
      "type": "custodial",
      "address": "0x7B3a9F2c4D1eA8bF6390cE5d2B7fA104C8e3D9b1",
      "network": "polygon",
      "asset": "usdc",
      "balance": "1234.56",
      "estimatedValueUsd": "1234.56",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "endorsements": [
    {
      "type": "basic",
      "status": "pending",
      "requirements": {
        "complete": [
          "<string>"
        ],
        "pending": [
          "<string>"
        ],
        "missing": [
          "<string>"
        ],
        "issues": [
          "<string>"
        ]
      },
      "failure": {
        "code": "onboardingRejected",
        "message": "<string>",
        "retryable": true
      }
    }
  ],
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "id": "cst_01H9Xa8F5dN6mP3q",
  "object": "customer",
  "status": "processing"
}

{
  "error": "Unauthorized",
  "code": 1000,
  "msg": "unauthorized access",
  "status": 401,
  "cause": "signature"
}

{
  "error": "Unauthorized",
  "code": 1000,
  "msg": "unauthorized access",
  "status": 401,
  "cause": "signature"
}

Authorizations

Authorization

string

header

required

Token from POST /auth/token

Headers

Idempotency-Key

string

required

Client-supplied request key. Required on all non-auth POST requests.

Maximum string length: 256

Body

application/json

Create a new customer. Individuals require firstName and lastName. Businesses require companyLegalName and email, and do not accept person-name fields. PII fields (birthDate, residentialAddress, ipAddress, identifyingInformation) are write-only and never returned in responses. Whether identity verification is required, and whether OMS relies on your attestation or a vendor verifies, is configured per project, not per request.

type

enum<string>

required

Customer type. Individuals follow the project's KYC policy, businesses its KYB policy.

Available options:

individual,

business

Example:

"individual"

companyLegalName

string

Legal business name. Required for business creation; supports Unicode and punctuation. Only valid for business customers.

Maximum string length: 255

firstName

string

Individual customer's legal first name. Not accepted for business customers.

Example:

"Jane"

middleName

string

Individual customer's middle name. Not accepted for business customers.

lastName

string

Individual customer's legal last name. Not accepted for business customers.

Example:

"Smith"

string<email>

Example:

"jane@example.com"

phone

string

Primary phone in E.164 format.

Example:

"+12125551234"

birthDate

string

write-only

Date of birth in YYYY-MM-DD format. Write-only.

Example:

"1990-05-15"

nationality

string

ISO 3166-1 alpha-2 country code.

Example:

"US"

ipAddress

string

write-only

End-user's IP address. Used for geo-based compliance checks on the basic endorsement. Write-only.

externalId

string

Developer's own user ID for cross-referencing.

Example:

"usr_12345"

signedAgreement

boolean

default:false

Whether the customer has accepted OMS terms of service. Default false.

residentialAddress

object

Customer's residential address. Write-only.

Hide child attributes

residentialAddress.line1

string

Example:

"123 Main St"

residentialAddress.line2

string

residentialAddress.city

string

Example:

"New York"

residentialAddress.state

string

Example:

"NY"

residentialAddress.country

string

ISO 3166-1 alpha-2 country code.

Example:

"US"

residentialAddress.zipCode

string

Example:

"10001"

identifyingInformation

object[]

write-only

Array of ID documents. Write-only. Supported types: ssn, itin, driversLicense, passport.

Hide child attributes

identifyingInformation.type

enum<string>

required

Available options:

ssn,

itin,

driversLicense,

passport

Example:

"ssn"

identifyingInformation.issuingCountry

string

required

ISO 3166-1 alpha-2 country code.

Example:

"US"

identifyingInformation.number

string

required

The identification number.

Example:

"123456789"

endorsements

enum<string>[]

Endorsements to request: basic, cryptoCustody, usd. If omitted, OMS defaults to cryptoCustody and usd (which auto-includes basic).

Available options:

basic,

cryptoCustody,

usd

metadata

object | null

Hide child attributes

metadata.{key}

string

Response

Customer created

Customer response object. PII fields (birthDate, residentialAddress, ipAddress, identifyingInformation) are write-only — accepted in POST/PATCH but never returned in responses.

string

Example:

"cst_01H9Xa8F5dN6mP3q"

type

enum<string>

Customer type. Individuals are subject to the project's KYC policy, businesses to its KYB policy.

Available options:

individual,

business

Example:

"individual"

name

string

An individual's first, middle and last names joined by spaces, or a business's legal name. Left out when the customer has no name.

Example:

"Jane Smith"

firstName

string | null

Example:

"Jane"

middleName

string | null

Example:

null

lastName

string | null

Example:

"Smith"

string | null

Example:

"jane@example.com"

phone

string | null

Primary phone in E.164 format.

Example:

"+12125551234"

nationality

string | null

ISO 3166-1 alpha-2 country code.

Example:

"US"

externalId

string | null

Developer's own user ID for cross-referencing.

Example:

"usr_12345"

status

enum<string>

Where the customer is in onboarding. actionRequired carries a hold saying what to do, and rejected carries a failure. offboarded is a deleted or deactivated customer.

Available options:

pending,

actionRequired,

active,

rejected,

offboarded

Example:

"active"

hold

object

What you must do for a customer in actionRequired.

Hide child attributes

hold.code

string

required

Example:

"verificationRequired"

hold.message

string

required

failure

object

Why a customer or an endorsement was rejected.

Hide child attributes

failure.code

string

required

Example:

"onboardingRejected"

failure.message

string

required

failure.retryable

boolean

required

signedAgreement

boolean

Whether the customer has accepted OMS terms of service.

Example:

true

signedAgreementAt

string<date-time> | null

Timestamp when signedAgreement was set to true. Null if not yet signed.

Example:

"2026-03-20T14:15:22Z"

totalBalance

object

USD rollup of a customer's balances. Returned on GET /customers/{id} only — never on list, create, or update. Covers fiat wallets and custodial crypto wallets; noncustodial wallets are not yet valued, so a customer holding one reads an undercount here. Omitted entirely when the rollup cannot be read; a partial total is never returned, so treat an absent field as "unknown", not as zero.

Hide child attributes

totalBalance.totalUsd

string

fiatUsd + cryptoUsd, 2 decimal places, sign preserved.

Example:

"1250.00"

totalBalance.fiatUsd

string

Sum of the customer's USD fiat wallet balances as last reported by the holding bank. Can be negative — an ACH clawback can overdraw a deposit account — so render the sign verbatim and never clamp.

Example:

"1000.00"

totalBalance.cryptoUsd

string

Sum of the customer's custodial crypto wallet balances at the custodian's own per-asset USD estimate. "0.00" for a customer with no custodial crypto account.

Example:

"250.00"

wallets

object[]

Simplified flat view: one entry per wallet-asset combination. Use GET /wallets/{id} for the full representation.

Hide child attributes

wallets.id

string

Example:

"wlt_01H9Xb3K7nM2pQ4r"

wallets.type

string

Example:

"custodial"

wallets.address

string

Example:

"0x7B3a9F2c4D1eA8bF6390cE5d2B7fA104C8e3D9b1"

wallets.network

string

Example:

"polygon"

wallets.asset

string

Example:

"usdc"

wallets.balance

string

Example:

"1234.56"

wallets.estimatedValueUsd

string

Example:

"1234.56"

wallets.createdAt

string<date-time>

endorsements

object[]

What the customer is endorsed for. An endorsement never reads further along than its customer, and one that was not requested is left out.

Hide child attributes

endorsements.type

enum<string>

required

Available options:

basic,

cryptoCustody,

usd

endorsements.status

enum<string>

required

Available options:

pending,

actionRequired,

active,

rejected,

offboarded

endorsements.requirements

object

Tracks what is complete, pending, missing, or has issues for this endorsement.

Hide child attributes

endorsements.requirements.complete

string[]

endorsements.requirements.pending

string[]

endorsements.requirements.missing

string[] | null

endorsements.requirements.issues

string[]

endorsements.failure

object

Why a customer or an endorsement was rejected.

Hide child attributes

endorsements.failure.code

string

required

Example:

"onboardingRejected"

endorsements.failure.message

string

required

endorsements.failure.retryable

boolean

required

metadata

object | null

Hide child attributes

metadata.{key}

string

createdAt

string<date-time>

updatedAt

string<date-time>

Overview

Move money

Routes

External Payment Methods

Platform

Create a customer

Authorizations

Headers

Body

Response