Put Customer
PUT/customers/:CustomerID
Creates or updates a customer record. A unique CustomerID
must be provided, as the API does not generate this identifier. For consistency, it is recommended to use the customer ID from your internal system as the CustomerID
. This customer record must exist before executing any operations that depend on the CustomerID
.
Request
Path Parameters
Possible values: non-empty
and <= 36 characters
Header Parameters
Digitally signed JWT.
- application/json
Body
required
Array [
- DrivingLicense
- NationalIDCard
- Passport
- AddressProof
- ResidencePermit
- TaxID
]
FullNameobjectrequired
user's first name
Possible values: non-empty
and <= 50 characters
user's last name (family name)
Possible values: non-empty
and <= 50 characters
user's middle name
Possible values: non-empty
and <= 50 characters
Possible values: >= 10 characters
and <= 10 characters
2024-04-16
Identitiesobject[]required
ISO 3166-1 alpha-2 country code.
US
Possible values: non-empty
and <= 36 characters
Possible values: >= 10 characters
and <= 10 characters
2024-04-16
Possible values: >= 10 characters
and <= 10 characters
2024-04-16
Type of identification document:
Passport
PrimaryResidenceobjectrequired
Street: the primary name of an address's street.
Possible values: >= 2 characters
and <= 200 characters
Street2: the secondary name of an address's street.
City: name of an address's city or town.
Possible values: non-empty
and <= 100 characters
PostCode: the address's postcode
Possible values: non-empty
and <= 20 characters
State: the address's state / province / county. For USA and Canada, state code in ISO 3166-2 code (e.g. CA) is required.
Possible values: non-empty
and <= 100 characters
ISO 3166-1 alpha-2 country code.
US
Responses
- 201
- 204
- 400
- 401
- 500
- application/json
- Schema
- Example (from schema)
Schema
- InvalidMessage
- Unexpected
- ResourceNotFound
- Unauthorized
- Forbidden
- InsufficientBalance
Array [
]
Type of error:
InvalidMessage
A unique reference that identifies the specific occurrence of the problem
Action taking place which resulted in error.
Details about the error.
Extensionsobject
Additional information about the error.
Details about invalid request properties.
Featuresobject
Details about the disabled feature flags
property name*
string[]
List of reasons
string
{
"Type": "InvalidMessage",
"Instance": "string",
"Action": "string",
"Detail": "string",
"Extensions": {
"Request": {},
"Features": {}
}
}
- application/json
- Schema
- Example (from schema)
Schema
- InvalidMessage
- Unexpected
- ResourceNotFound
- Unauthorized
- Forbidden
- InsufficientBalance
Array [
]
Type of error:
InvalidMessage
A unique reference that identifies the specific occurrence of the problem
Action taking place which resulted in error.
Details about the error.
Extensionsobject
Additional information about the error.
Details about invalid request properties.
Featuresobject
Details about the disabled feature flags
property name*
string[]
List of reasons
string
{
"Type": "InvalidMessage",
"Instance": "string",
"Action": "string",
"Detail": "string",
"Extensions": {
"Request": {},
"Features": {}
}
}
- application/json
- Schema
- Example (from schema)
Schema
- InvalidMessage
- Unexpected
- ResourceNotFound
- Unauthorized
- Forbidden
- InsufficientBalance
Array [
]
Type of error:
InvalidMessage
A unique reference that identifies the specific occurrence of the problem
Action taking place which resulted in error.
Details about the error.
Extensionsobject
Additional information about the error.
Details about invalid request properties.
Featuresobject
Details about the disabled feature flags
property name*
string[]
List of reasons
string
{
"Type": "InvalidMessage",
"Instance": "string",
"Action": "string",
"Detail": "string",
"Extensions": {
"Request": {},
"Features": {}
}
}