API Reference

Onboard an individual

post
https://example.com/onboarding/v2/individuals

Similar to the Company onboarding, the Individual onboarding endpoint allows you to onboard any individual or physical person who is part of a transaction. In most cases (i.e. B2C transactions), the Customer will be a physical person and you should use this endpoint to onboard them.

Body Params
address
object
contact_details
object
string
required

Full name of the individual

Validations:

  • Required property
  • Length between 1 and 450
meta
object
boolean
string
required

Specifies a unique personal identifier for a b2c customer. This can be customers’ email address, account number, etc. Used for deduplication purposes.

Validations:

  • Required property
  • Length between 1 and 50
string

Validations:

  • Length between 0 and 20
tax_information
object
Responses

401

Authentication failed - missing or incorrect subscription key.

409

Conflict - the individual already exists.

429

Too many requests were sent for a short period of time. Try again a bit later.

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago