StatusLog In
API Reference and Guides

Sections

Theme switcher

/accounts/individual

Header Parameters

idempotencystring
Max length
36
Pattern
^[a-zA-Z 0-9-_+=/]*$
Authorizationstring

Body Parameters

dateOfBirthstring

Date of birth of the individual being registered.

writeOnly
emailstring

Email of the individual being registered. This is required if Send is compelting KYC on the account.

Min length
3
Max length
254
firstNamestring Required

First Name of the individual being registered.

lastNamestring Required

Last Name of the individual being registered.

middleNamestring

Middle Name of the individual being registered. This is required if the individual has a middle name.

phoneCountryCodestring

Country calling code for the phone number of the individual. It needs to be prefixed with a +.

Min length
2
Max length
5
Pattern
^\+[0-9]{2,4}$
phonestring

Phone number of the individual being registered. Required if Send is completing KYC on the individual.

Min length
3
Max length
15
countryOfBirthstring

Country where the individual was born.

Min length
2
Max length
2
writeOnly
physicalAddressobject Required

Address object representing the physical address of the individual, not the postal address. Can use any valid combination of optional address lines.

writeOnly

Show child attributes

primaryIdentificationobject

Primary ID document details.

writeOnly

Show child attributes

termsAndConditionsAcceptedboolean

Flag to confirm that the individual has been shown and explicitly accepted Sends Terms and Conditions.

externalReferencestring

An optional value that can be passed in to later reference a related resource in the partner system.

Response

201
Object
Successful response.

Response Attributes

itemobject

Show child attributes

400
Object
Bad Request

Response Attributes

messagestring Required
errorsarray Required

Show child attributes

401
Object
Unauthorized

Response Attributes

messagestring
errorsarray Required

Show child attributes

409
Object
Conflict

Response Attributes

messagestring
errorsarray Required

Show child attributes

500
Object
Unknown Error

Response Attributes

messagestring
errorsarray Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?