Customer account creation

The customer account creation comprises of two API calls. One API endpoint creates a customer bank account using a minimum data needed. The second API calls creates a KYC applicant and extends the amount of personal data stored for the customer. Use the following API requests.

Create a customer bank account

Creates a bank transfer user profile.

post

Creates a bank transfer user profile for a specified customer.

Access to this endpoint requires a valid API key. The API key is sent in the x-api-key header on requests.

Authorizations
Path parameters
idstringRequired
  • The external identifier for the customer.
Body
  • Request body containing user details.
currencystring ยท enumOptionalPossible values:
countrystringOptional
emailstringOptional
lastNamestringOptional
firstNamestringOptional
Responses
201

User successfully created

application/json
post
POST /api/v2/customer/{id}/bank-transfer/user HTTP/1.1
Host: localhost:8000
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "country": "GB",
  "currency": "EUR",
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe"
}
{
  "data": "User successfully created",
  "success": true
}

Create a KYC applicant

Submits KYC applicant information for a customer to the KYC provider.

post

Submits KYC applicant information for a customer to the KYC provider.

Access to this endpoint requires a valid API key. The API key is sent in the x-api-key header on requests.

Authorizations
Path parameters
idstringRequired
  • Unique identifier of the customer.
Body
  • The request body containing applicant information.
address2stringOptional
address1stringOptional
sourceOfFundsstring ยท enumOptionalPossible values:
countrystringOptional
citystringOptional
postCodestringOptional
dateOfBirthstring ยท date-timeOptional
Responses
201

KYC applicant was created successfully

application/json
post
POST /api/v2/customer/{id}/bank-transfer/kyc/applicant HTTP/1.1
Host: localhost:8000
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "address1": "45 Pitt Street",
  "address2": "Level 2, Suite 3",
  "postCode": "2000",
  "city": "Sydney",
  "country": "AU",
  "dateOfBirth": "1990-12-25",
  "sourceOfFunds": "SALARY"
}
{
  "data": "KYC applicant was created successfully",
  "success": true
}

Last updated