PaaS API Docs
Search…
Business Representatives
Read for details on adding, updating and retrieving business representatives
For every business user, you will have to also provide information on corresponding business representatives which include the account operator, all beneficial owners (25% or more ownership of the company), and key operating members.
Add a business representative
POST /users/{{user_id}}/business-representative
Details
Request Sample
Response Sample
Business Representative Object
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’, ‘ACCOUNT_OPERATOR|BENEFICIAL_OWNER’
virtual_document
Yes, if US citizen and Account operator.
Object
Identification document's information.
virtual_document.document_type
Yes, if US citizen and Account operator.
String
Enum values are mentioned below.
virtual_document.document_value
Yes, if US citizen and Account operator.
String
ID number of the document.
physical_document
Yes, if non-US citizen and Account_Operator
Object
Copy of a document.
physical_document.document_value
Yes, if non-US citizen and Account_Operator
String
Value of the document. Physical documents must be encoded Base64 before being uploaded to our system.
physical_document.document_value_back
No
String
Value of the rear side of the document. Physical documents must be encoded Base64 before being uploaded to our system.
physical_document.document_type
Yes, if non-US citizen and Account_Operator
String
Enum values are mentioned below.
Physical Document Type Enumerated Values
PASSPORT
DRIVING_LICENCE
Virtual Document Type Enumerated Values
SSN
curl --location --request POST '{{url}}/users/{{user_id}}/business-representative' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"first_name": "John",
"middle_name": null,
"last_name": "Sherpa",
"city": "San Jose",
"state": "CA",
"country": "US",
"zipcode": "99705",
"address_line1": "123 Main Street Room 22",
"date_of_birth": "1997-09-08",
"type": "ACCOUNT_OPERATOR",
"virtual_documents": [
{
"document_value": "111111111",
"document_type": "SSN"
}
]
}'
{
"address_line1": "123 Main Street Room 22",
"city": "North Pole",
"date_of_birth": "1997-09-08",
"first_name": "John",
"id": {{UUID}},
"last_name": "Sherpa",
"physical_documents": [],
"virtual_documents": [
{
"document_value": "*****1111",
"id": {{UUID}},
"document_type": "SSN"
}
],
"zipcode": "99705",
"country": "US",
"type": "ACCOUNT_OPERATOR"
}
Update a business representative
PATCH /users/{{user_id}}/business-representative/{{id}}
Details
Request Sample
Response Sample
Updatable fields for business representative
Fields
Send user is verified
Send user is not verified
first_name
No
Yes
middle_name
No
Yes
last_name
No
Yes
date_of_birth
No
Yes
address_line1
Yes
Yes
city
Yes
Yes
state
Yes
Yes
country
Yes
Yes
zipcode
Yes
Yes
type
No
Yes
virtual_document
No
Yes
physical_document
Yes
Yes
curl --location --request PATCH '{{url}}/users/{{user_id}}/business-representative/{{id}}' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"first_name": "John",
"middle_name": null,
"last_name": "Sherpa",
"city": "North Pole",
"state": "CA",
"country": "US",
"zipcode": "99705",
"address_line1": "123 Main Street Room 22",
"date_of_birth": "1997-09-08",
"type": "ACCOUNT_OPERATOR",
"physical_documents": [
{
"document_value": "data:image/jpg;base64,SUQsasasasas909090==",
"document_value_back": "data:image/jpg;base64,SUQsasasas()()==",
"document_type": "DRIVING_LICENCE"
}
],
"virtual_documents": [
{
"document_value": "222222222",
"document_type": "SSN"
}
]
}'
{
"address_line1": "123 Main Street Room 22",
"city": "North Pole",
"date_of_birth": "1997-09-08",
"first_name": "John",
"id": {{UUID}},
"last_name": "Sherpa",
"physical_documents": [
{
"id": {{UUID}},
"document_type": "DRIVING_LICENCE"
}
],
"state": "CA",
"virtual_documents": [
{
"document_value": "*****2222",
"id": {{UUID}},
"document_type": "SSN"
}
],
"zipcode": "99705",
"country": "US",
"type": "ACCOUNT_OPERATOR"
}
Get a business representative's details
GET /users/{{user_id}}/business-representative/{{id}}
Request Sample
Response Sample
curl --location --request GET '{{url}}/users/{{user_id}}/business-representative/{{id}}' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
{
"address_line1": "123 Main Street Room 22",
"city": "North Pole",
"date_of_birth": "1997-09-08",
"first_name": "John",
"id": {{UUID}},
"last_name": "Sherpa",
"physical_documents": [
{
"id": {{UUID}},
"document_type": "DRIVING_LICENCE"
}
],
"state": "CA",
"virtual_documents": [
{
"document_value": "*****2222",
"id": {{UUID}},
"document_type": "SSN"
}
],
"zipcode": "99705",
"country": "US",
"type": "ACCOUNT_OPERATOR"
}
Get list of all business representative
GET /users/{{user_id}}/business-representative
Request Sample
Response Sample
curl --location --request GET '{{url}}/users/{{user_id}}/business-representative' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
{
"address_line1": "123 Main Street Room 22",
"city": "North Pole",
"date_of_birth": "1997-09-08",
"first_name": "John",
"id": {{UUID}},
"last_name": "Sherpa",
"physical_documents": [
{
"id": {{UUID}},
"document_type": "DRIVING_LICENCE"
}
],
"state": "CA",
"virtual_documents": [
{
"document_value": "*****2222",
"id": {{UUID}},
"document_type": "SSN"
}
],
"zipcode": "99705",
"country": "US",
"type": "ACCOUNT_OPERATOR"
},
{
"address_line1": "123 Main Street Room 22",
"city": "Everest",
"date_of_birth": "1997-09-08",
"first_name": "Jane",
"id": "7781cd86-a820-4712-8713-def58750a836",
"last_name": "Sherpa",
"physical_documents": [],
"state": "CA",
"virtual_documents": [
{
"document_value": "*****3333",
"id": {{UUID}},
"document_type": "SSN"
}
],
"zipcode": "99705",
"country": "US",
"type": "BENEFICIAL_OWNER"
}
]
Copy link