Business Representatives Object
Read for details on adding, updating and retrieving business representatives
Field
Required
Type
Description
first_name
Yes
String
First name of the business representative.
middle_name
No
String
Middle name of the business representative.
last_name
Yes
String
Family name of the business representative.
date_of_birth
Yes
String
Date of birth of business representative
address_line1
Yes
String
Street address of the business representative.
city
Yes
String
City of the business representative.
state
Yes
String
2-letter ISO code of the business representative’s state.
country
Yes
String
2-letter ISO code of the business representative’s country.
zipcode
Yes
String
Zip code of the business representative’s address.
type
Yes
Category
Enumerated value: ‘ACCOUNT_OPERATOR’, ‘BENEFICIAL_OWNER’, ‘COMPLIANCE’, 'PRIMARY CONTROLLER’
Note: This field will be deprecated. Suggested to use br_type.
br_type
Yes
Object
Set true or fasle based on what type of business representative you are creating.
br_type.account_operator
Yes
Boolean
True or False.
To initiate KYB, “ACCOUNT OPERATOR” is required.
br_type.beneficial_owner
Yes
Boolean
Set True or False.
br_type.compliance
Yes
Boolean
Set True or False.
br_type.primary controller
Yes
Boolean
Set True or False.
Yes
String
Email id of the business representative.
virtual_documents
Conditional
Object
Identification document's information. Details on the required documents are outlined in your spec sheet.
virtual_documents.document_type
Yes, if virtual_documents is provided
String
Enumerated values are listed below.
virtual_documents.document_value
Yes, if virtual_documents is provided
String
ID number of the document.
virtual_documents.issue_date
Conditional
String
Date of issue of the document.
virtual_documents.id_issuing_authority
Conditional
String
The department issuing the ID.
virtual_documents.country
Conditional
String
2-letter ISO code of the user's country.
virtual_documents.state
Conditional
String
2-letter ISO code of the user's state.
virtual_documents.expiry_date
Conditional
String
Date of expiry of the document.
physical_documents
Conditional
Object
Copy of a document. Details on the required documents are outlined in your spec sheet.
physical_documents.document_value
Yes, if physical_documents is provided
String
Value of the document. Physical documents must be encoded Base64 before being uploaded to our system.
physical_documents.document_value_back
Yes, if physical_documents is provided
String
Value of the rear side of the document. Physical documents must be encoded Base64 before being uploaded to our system.
physical_documents.document_type
Yes, if physical_documents is provided
String
Enumerated values are listed below.
physical_documents.country
Conditional
String
2-letter ISO code of the user’s country.
physical_documents.state
Conditional
String
2-letter ISO code of the user’s state.
physical_documents.expiry_date
Conditional
String
Date of expiry of the document.
phone
Yes
Numeric
Mobile number of the contact person.
gender
Yes
String
Gender of business representative.
title
Yes
String
Title of buinsess representative.
ownership_percentage
Yes, if Beneficial Owner
Numeric
Mandatory field for business representative of type “beneficial owner”.
Physical Document Type Enumerated Values
Virtual Document Type Enumerated Values
Last updated