StatusLog In
API Reference and Guides

Sections

Theme switcher

/accounts/{accountId}

Header Parameters

Authorizationstring

Path Parameters

accountIdstring Required
Min length
38
Max length
100
Pattern
[a-zA-Z]{1,63}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Response

200
Object
Successful response.

Response Attributes

OneOf 

accountIdstring

The account id for the created account. This is used in subsequent requests to execute trades and payments on behalf of the account. In the future, accounts will be able to operate multiple accounts for greater control and flexibility.

Min length
38
Max length
100
Pattern
account_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
readOnly
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

First Name of the individual being registered.

lastNamestring

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.

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

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.

statusstring

Registration status of the individual account.

Enum values:
submittedpendingactiverejectedinactive
readOnly
createdAtstring

The UTC date-time that the account was created.

Min length
20
Max length
20
readOnly
updatedAtstring

The UTC date-time that the account was last updated.

Min length
20
Max length
20
readOnly
externalReferencestring

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

400
Object
Bad Request

Response Attributes

messagestring Required
errorsarray Required

Show child attributes

401
Object
Unauthorized

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?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?