Update customer details
With these endpoints, you can update information about a specific customer within the system: key customer data, including their profile, associated wallets, and other relevant details. You can update the customer's profile, address, and other relevant details.
Update customer details
To update the detailed information of a specific customer, send the PUT /platform/v1/customers/{customerReference} with the {customerReference} specified in the path.
In the request body, you can update the following fields:
{
"name": "Updated Company Name",
"description": "Updated description",
"address": {
"addressLine1": "Updated Address Line 1",
"addressLine2": "Updated Address Line 2",
"city": "Updated City",
"postalCode": "Updated Postal Code",
"countryCode": "US",
"country": "United States"
}
}
In the successful response, you receive the updated customer information:
{
"reference": "8a0e1da2-2af3-4b9e-a221-e74db4e01b06",
"status": "PENDING",
"type": "COMPANY",
"company": {
"name": "Updated Company Name",
"description": "Updated description",
"taxResidenceCountryCode": "US",
"registrationNumber": "21-4532998",
"address": {
"addressLine1": "Updated Address Line 1",
"addressLine2": "Updated Address Line 2",
"city": "Updated City",
"postalCode": "Updated Postal Code",
"countryCode": "US",
"country": "United States"
},
"associates": [
{
"person": {
"reference": "911685b0-acaa-418d-bd91-ed80b96c62cf",
"firstName": "Sean",
"lastName": "Bond",
"dateOfBirth": "2001-01-31",
"address": {
"addressLine1": "101 West Broadway",
"addressLine2": "Suite 1975",
"city": "San Diego",
"postalCode": "92101",
"countryCode": "US",
"country": "United States"
}
},
"details": {
"birthCountryCode": "US",
"contactInfo": {
"emailAddress": "Sean.Bond@disney.com",
"phoneNumber": "+123456789"
},
"documentNumber": "123456789",
"documentInfo": {
"number": "123456789",
"type": "DRIVERS_LICENSE",
"issuingCountryCode": "US"
},
"taxIdentification": {
"number": "914764628",
"taxResidenceCountryCode": "US"
}
},
"title": "CEO",
"riskScore": "LOW",
"controls": {
"hasOwnership": true,
"hasControl": true,
"isSigner": false
},
"verification": {
"url": "https://verify.com/2",
"status": "infoRequired"
}
}
],
"verification": {
"url": "https://verify.com/1",
"status": "infoRequired"
}
},
"riskScore": "LOW"
}
| Attribute | Type | Description |
|---|---|---|
| name | String | Updated name of the company. |
| description | String | Updated description of the company. |
| address | Object | Updated address of the company. |
| address.addressLine1 | String | Updated primary address line. |
| address.addressLine2 | String | Updated secondary address line. |
| address.city | String | Updated city. |
| address.postalCode | String | Updated postal code. |
| address.countryCode | String | Updated country code. |
| address.country | String | Updated full country name. |
Update customer status
To update the status of a specific customer, send the PUT /platform/v1/customers/{customerReference}/status with the {customerReference} specified in the path.
In the request body, you can update the status:
{
"status": "VERIFIED"
}
In the successful response, you receive the updated customer status:
{
"reference": "8a0e1da2-2af3-4b9e-a221-e74db4e01b06",
"status": "VERIFIED",
"type": "COMPANY",
"company": {
"name": "Updated Company Name",
"description": "Updated description",
"taxResidenceCountryCode": "US",
"registrationNumber": "21-4532998",
"address": {
"addressLine1": "Updated Address Line 1",
"addressLine2": "Updated Address Line 2",
"city": "Updated City",
"postalCode": "Updated Postal Code",
"countryCode": "US",
"country": "United States"
},
"associates": [
{
"person": {
"reference": "911685b0-acaa-418d-bd91-ed80b96c62cf",
"firstName": "Sean",
"lastName": "Bond",
"dateOfBirth": "2001-01-31",
"address": {
"addressLine1": "101 West Broadway",
"addressLine2": "Suite 1975",
"city": "San Diego",
"postalCode": "92101",
"countryCode": "US",
"country": "United States"
}
},
"details": {
"birthCountryCode": "US",
"contactInfo": {
"emailAddress": "Sean.Bond@disney.com",
"phoneNumber": "+123456789"
},
"documentNumber": "123456789",
"documentInfo": {
"number": "123456789",
"type": "DRIVERS_LICENSE",
"issuingCountryCode": "US"
},
"taxIdentification": {
"number": "914764628",
"taxResidenceCountryCode": "US"
}
},
"title": "CEO",
"riskScore": "LOW",
"controls": {
"hasOwnership": true,
"hasControl": true,
"isSigner": false
},
"verification": {
"url": "https://verify.com/2",
"status": "infoRequired"
}
}
],
"verification": {
"url": "https://verify.com/1",
"status": "infoRequired"
}
},
"riskScore": "LOW"
}
| Attribute | Type | Description |
|---|---|---|
| status | String | Updated status of the customer (e.g., "VERIFIED"). Possible statuses could include PENDING, VERIFIED, REJECTED. |
Update customer associates
To update the associates of a specific customer, send the PUT /platform/v1/customers/{customerReference}/associates with the {customerReference} specified in the path.
In the request body, you can update the associates:
{
"associates": [
{
"person": {
"firstName": "Updated First Name",
"lastName": "Updated Last Name",
"dateOfBirth": "2001-01-31",
"address": {
"addressLine1": "Updated Address Line 1",
"addressLine2": "Updated Address Line 2",
"city": "Updated City",
"postalCode": "Updated Postal Code",
"countryCode": "US",
"country": "United States"
}
},
"details": {
"birthCountryCode": "US",
"contactInfo": {
"emailAddress": "updated.email@example.com",
"phoneNumber": "+123456789"
},
"documentNumber": "123456789",
"documentInfo": {
"number": "123456789",
"type": "DRIVERS_LICENSE",
"issuingCountryCode": "US"
},
"taxIdentification": {
"number": "914764628",
"taxResidenceCountryCode": "US"
}
},
"title": "Updated Title",
"riskScore": "LOW",
"controls": {
"hasOwnership": true,
"hasControl": true,
"isSigner": false
}
}
]
}
In the successful response, you receive the updated customer associates:
{
"reference": "8a0e1da2-2af3-4b9e-a221-e74db4e01b06",
"status": "VERIFIED",
"type": "COMPANY",
"company": {
"name": "Updated Company Name",
"description": "Updated description",
"taxResidenceCountryCode": "US",
"registrationNumber": "21-4532998",
"address": {
"addressLine1": "Updated Address Line 1",
"addressLine2": "Updated Address Line 2",
"city": "Updated City",
"postalCode": "Updated Postal Code",
"countryCode": "US",
"country": "United States"
},
"associates": [
{
"person": {
"reference": "911685b0-acaa-418d-bd91-ed80b96c62cf",
"firstName": "Updated First Name",
"lastName": "Updated Last Name",
"dateOfBirth": "2001-01-31",
"address": {
"addressLine1": "Updated Address Line 1",
"addressLine2": "Updated Address Line 2",
"city": "Updated City",
"postalCode": "Updated Postal Code",
"countryCode": "US",
"country": "United States"
}
},
"details": {
"birthCountryCode": "US",
"contactInfo": {
"emailAddress": "updated.email@example.com",
"phoneNumber": "+123456789"
},
"documentNumber": "123456789",
"documentInfo": {
"number": "123456789",
"type": "DRIVERS_LICENSE",
"issuingCountryCode": "US"
},
"taxIdentification": {
"number": "914764628",
"taxResidenceCountryCode": "US"
}
},
"title": "Updated Title",
"riskScore": "LOW",
"controls": {
"hasOwnership": true,
"hasControl": true,
"isSigner": false
},
"verification": {
"url": "https://verify.com/2",
"status": "infoRequired"
}
}
],
"verification": {
"url": "https://verify.com/1",
"status": "infoRequired"
}
},
"riskScore": "LOW"
}
| Attribute | Type | Description |
|---|---|---|
| associates | Array | Updated list of associates for the company. |
| associates.person.firstName | String | Updated first name of the associate. |
| associates.person.lastName | String | Updated last name of the associate. |
| associates.person.dateOfBirth | String | Updated date of birth of the associate. |
| associates.person.address | Object | Updated address of the associate. |
| associates.details.contactInfo.emailAddress | String | Updated email address of the associate. |
| associates.details.contactInfo.phoneNumber | String | Updated phone number of the associate. |
| associates.title | String | Updated title of the associate. |
| associates.riskScore | String | Updated risk score of the associate. |
| associates.controls.hasOwnership | Boolean | Updated ownership status of the associate. |
| associates.controls.hasControl | Boolean | Updated control status of the associate. |
| associates.controls.isSigner | Boolean | Updated signer status of the associate. |