Create partner customer

POST

/partner/v1/customers

Request

Header Params

Body Params application/jsonRequired

Example

{
    "partnerCustomerRef": "string",
    "customerType": "INDIVIDUAL",
    "displayName": "string",
    "metadata": {
        "property1": "string",
        "property2": "string"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/partner/v1/customers' \
--header 'X-Partner-Client-Id;' \
--header 'X-Partner-Timestamp;' \
--header 'X-Partner-Nonce;' \
--header 'X-Partner-Signature;' \
--header 'X-Request-Id;' \
--header 'Idempotency-Key;' \
--header 'Content-Type: application/json' \
--data '{
    "partnerCustomerRef": "string",
    "customerType": "INDIVIDUAL",
    "displayName": "string",
    "metadata": {
        "property1": "string",
        "property2": "string"
    }
}'

Responses

🟢201Created

application/json

Customer created or existing customer returned.

Bodyapplication/json

Example

{
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "partnerCustomerRef": "string",
    "customerType": "INDIVIDUAL",
    "status": "DRAFT",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠409

Modified at 2026-06-28 00:04:35

Errors

Upload or link a file to a partner customer