v1

latestOpenAPI 3.0.02026-07-22290108.6 KB

Payer

V2/Payer

Create compliance data for a user

Checks compliance status and returns necessary URLs for completing compliance.

post/v2/payer

Headers

x-api-keystring required

API key for authentication

Request body

clientUserIdstring required

Client User ID

emailstring email required

firstNamestring required

First Name

lastNamestring required

Last Name

beneficiaryType'individual' | 'business' required

companyNamestring

Company Name

dateOfBirthstring required

Date of birth in YYYY-MM-DD format

addressLine1string required

Address Line 1

addressLine2string

Address Line 2

citystring required

City

statestring required

State

postcodestring required

Postcode

countrystring required

Country

nationalitystring required

Nationality

phonestring required

Phone in E.164 format

ssnstring required

Social Security Number

sourceOfFundsstring

Source of Funds

businessActivitystring

Business Activity

Response

Compliance data retrieved successfully

agreementUrlstring uri

kycUrlstring uri

userIdstring uuid