Skip to navigation
API ReferenceCustomersAPI IntegrationCustomers

Register a Customer

Register a new customer in the system. Since customer registration is processed asynchronously, you’ll receive a unique_identifier right away while the full customer record is being created. Use this identifier to retrieve the finalized customer data, or set up webhooks to receive automatic notifications when the customer’s status changes.

Authentication: Bearer token required

Use Cases:

  • Register new customers for payment services
  • Onboard customers with complete profile information
  • Set up customer accounts for international transfers
  • Enable customers for foreign exchange (FX) and currency conversion services
  • Register business customers for B2B payment processing and bulk transactions
  • Onboard property transaction customers for real estate payment processing
  • Create customer records for multi-currency account management
  • Set up KYC/AML compliance for new customers before processing payments
  • Register customers for third-party payment processing and property-related transactions
  • Initialize customer accounts for receiving quotes and managing currency exchange operations

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the Authentication section for detailed information on how to obtain and use your OAuth credentials.

Request

This endpoint expects an object.
customer_typeenumRequired

The type of customer being registered.

Allowed values:

  • Personal: Use this for individual customers registering for personal transactions. This is suitable for individuals making personal payments, transfers, or currency exchanges.
  • Business: Use this for business entities, corporations, or organizations. When selecting “Business”, you should provide company details in the company field including business registration information, incorporation details, and business address.
Allowed values:
contactslist of objectsRequired

Customer-facing contacts responsible for communication and trading authorisation. Provide one or two contact records for each customer.

additional_detailsobjectRequired
companyobjectOptional

Response

OK. Everything worked as expected. The customer object was created and is pending review. The returned temporary customer number can be used to check for the Customer ID.
client_reference_idstring
Unique reference id that you want to assign to this customer for your own purposes
unique_identifierstring

A unique identifier returned immediately after customer registration. Use this identifier with the Get Customer’s ID endpoint to retrieve the customer’s ID once the registration process is complete.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error