KYC verification

The platform offers different choices for performing KYC check. Based on the selected KYC provider, a check is performed and the results are shared

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The data of the customer to be verified

Represents a customer

string
length ≤ 256

A unique customer ID associated with the customer. It's a system generated value

name
object
required

The customer's name

string
required

Country specific Tax Id associated with this customer (SIN or NAS in Canada, SSN or TIN in US, etc.)

string

Tax id type indicator SSN, EIN, SIN (Canada), BN (Canada), RFC (Mexico)

string
length between 2 and 2

Country 2-digit code that issued the customer’s taxId

string

A federal (such as passport) or state (such as driver's license) issued identifier

boolean

Represents whether customer's name was found in U.S Government's OFAC list

fiAttributes
array of objects

List of custom attributes. Some clients may capture some additional details from customer during onboarding flow. This list is a placeholder for such information

fiAttributes
string
enum

Customer type indicator. For Consumer customers Individual would be returned

Allowed:
boolean

True opt-in, False opt-out

date

Last contact date

string

Unique customer identifier assigned by the external partner (bank) within the tenant.

boolean

Terms and Conditions accepted

date-time

Terms and Conditions accepted

contact
object

Contact information associated with this customer

person
object

Personal or individual customer information

string
string
string
dueDiligence
object
string

Needed when the verification is for a business representative

string

Needed when the verification is for a business representative

Headers
uuid
required

A unique request identifier associated with the request. It's typically a UUID generated for each request, can be used for request tracking purposes.

string

It's an optional header that identifies the end-user of client application. In some cases, client application is expected to send CustomerId associated with the authenticated user.

string

It's an optional header used for internal purposes. It's an alias that overrides the default tenant associated with the authorization token.

string
required
length ≤ 256

A unique request identifier associated with the request. This is different from x-rquid header. This value is used to identify duplicate requests.

string

Unique header to specify the environment. Possible values DEV / STAGING

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json