Skip to main content
Create a party

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

1 to 255 printable ASCII characters with no spaces, quotes or backslashes, in double quotes as the IETF draft defines, or without them. We recommend a UUID. Make one for each thing you mean to happen once and store it before you send the request, so a retry after a crash sends the same key. Keys are scoped to your account and the endpoint, not to a token, so a new token or a rotated secret doesn't affect a retry. A partner and its merchant are separate accounts, so the same key sent with each credential starts two requests. Keys are kept for at least 7 days. After that, the same key starts a new request.

Required string length: 1 - 257
Pattern: ^(?:([\x21\x23-\x5B\x5D-\x7E]{1,255})|"([\x21\x23-\x5B\x5D-\x7E]{1,255})")$

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
type
enum<string>
required
Available options:
individual,
company
party_roles
enum<string>[]
required
Minimum array length: 1
Available options:
owner,
director,
executive,
representative
ownership_percent
string
required

From "0.00", which a director can hold, to "100.00", to two decimal places.

Pattern: ^(100(\.0{1,2})?|\d{1,2}(\.\d{1,2})?)$
first_name
string
required unless type = company
Required string length: 1 - 30
Pattern: \S
last_name
string
required unless type = company
Required string length: 1 - 30
Pattern: \S
email
string<email>
required unless type = company
Maximum string length: 320
Pattern: ^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
phone
string
required unless type = company
Minimum string length: 8
Pattern: ^\+[1-9]\d{1,14}$
date_of_birth
string<date>
required unless type = company
country_of_citizenship
string
required unless type = company
Pattern: ^[A-Z]{2}$
residential_address
object
required unless type = company
Required string length: 2 - 160
Pattern: \S
registration_number
string
required if type = company
Required string length: 4 - 20
Available options:
limited_liability_company,
private_limited_company,
public_limited_company,
general_partnership,
limited_liability_partnership,
limited_partnership,
limited_liability_entrepreneurial_company,
joint_stock_company,
single_member_llc,
multi_member_llc,
private_partnership,
private_corporation,
public_company
country_of_incorporation
string
required if type = company
Pattern: ^[A-Z]{2}$
incorporation_date
string<date>
registered_address
object
required if type = company
contact_full_name
string
required if type = company
Required string length: 2 - 160
contact_email
string<email>
required if type = company
Maximum string length: 320
Pattern: ^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
contact_phone
string
required if type = company
Minimum string length: 8
Pattern: ^\+[1-9]\d{1,14}$

Response

The party, in the full view.

result
object
required
entities
object
required

Nothing can be included here.

not_included
object[]
required