Business Verification
Overview
This endpoint allows you to verify a business identity, including the identities of any associated persons. Business verification requires a business registration document or a bank account statement. Associated person verification requires a liveness check or upload of a trusted selfie and government ID.
Prerequisites
You must have uploaded the required business documents and associated person documents using the Asset Upload Guide.
Steps
1. Obtain Document Filenames
Retrieve the filenames of the uploaded business documents and associated person documents from the asset upload response.
2. Prepare Business Verification Request
Construct a POST request to the business verification endpoint (
$host/identity/workflow/business
).Include the business document filename in the appropriate field (e.g.,
business_registration_filename
,bank_statement_filename
).Include the business details (e.g., business name, address).
Include an array of associated person objects, each containing their document filenames and person details.
Request Body Parameters
name
String
The business name
Yes
String
Business email address
Yes
website
String
Business website URL
Yes
phone_number
String
Business phone number
No
document
Object
Document information
Yes
document.type
String
Document type: account-statement
or business-registration
Yes
document.url
String
Filename returned in the asset upload endpoint
Yes
address
Object
Business address information
Yes
address.country_code
String
Country code
No
address.state_code
String
State/province code
No
address.city
String
City name
No
address.street_address1
String
Primary street address
No
address.street_address2
String
Secondary street address
No
address.zip_code
String
ZIP or postal code
No
associated_persons
Array
Array of person(s) related to the business
Yes
liveness_check
Bool
The default is true This indicates whether liveness check is required for each associated person
No
webhook_url
String
URI where verification status changes are sent
No
demo
Object
Testing configuration (omit for live verifications)
No
demo.status
Boolean
Demo status flag
No
demo.flag
Boolean
Demo flag
No
Sample Request
Sample Response
3. Receive Liveness Check Links for Associated Persons
The API will generate unique liveness check links for all associated persons requiring liveness check. The links will be delivered via a webhook to your specified endpoint. This might take a few seconds. The webhook will contain liveness check links for all associated persons.
Example Webhook Response
4. Receive Liveness Check Status for Associated Person
You will receive a webhook notification when all associated persons have completed their liveness checks. You can check the liveness check status of an individual or associated person by calling the {baseUrl}/identity/workflow/liveness/<workflow_id>
endpoint.
Sample Response
5. Receive Verification Response
The API will return a JSON response with the verification status. If associated persons require liveness checks, their status will be AwaitingLivenessCheck
. If not, the status will be Running
, Completed
or Failed
. Once all associated persons complete liveness checks, the business verification process will continue to Completed
or Failed
.
Example AwaitingLivenessCheck Response
Example Completed Response
Example Failed Response
Sample Business Verification Object
Example Webhook Request Body
Response Details
Successful Response (200 OK)
JSON object with verification_status: completed
.
Pending Response (200 OK)
JSON object with verification_status: AwaitingLivenessCheck
.
Error Response
JSON object with an error
field containing an error message and/or code.
Document Requirements
Business Document Requirements
Business registration document (PDF, JPG, PNG)
Bank account statement (PDF, JPG, PNG)
Associated Persons Requirements
We highly recommend that all associated persons complete a liveness check. Liveness check must be completed before the business verification can be completed.
The business verification status will remain
Running
until all associated person liveness checks are successful.You can opt to upload verification documents instead of a liveness check:
Government ID (PNG, JPG)
Selfie (PNG, JPG)
The business verification status will be
Running
until it moves toCompleted
orFailed
Error Handling:
400 Bad Request: Invalid filenames, missing required fields, or invalid data.
404 Not Found: One or more specified files were not found.
500 Internal Server Error: Server-side error during verification.
Last updated
Was this helpful?