Skip to main content
Requirements

​
Business verification Schema

The recommended integration and use schema is provided below.
KYB Integration Schema

​
Check Flow

To determine what data should be provided for the form, review the flow information. This can be done by calling the Business verification Token Retrieve endpoint.
For the Business verification Token Retrieve endpoint (retrieves flow information related to the specific token, detailing the data required for form submission), see the API Reference tab for kybInfoRetrieve.
This step can be skipped if the same flow is used, as similar data fields should be provided.

​
Form Creation

Create a Business verification Form by sending a request to the form creation endpoint.
For the Create Business verification form endpoint (creates a new form linked to the generated token for capturing and submitting necessary compliance information), see the API Reference tab for kybFormsCreate.
After the form is created, the following operations are available:
  • Info Retrieve - Retrieves detailed information about an active Business verification session, including various aspects of the company’s compliance and verification process. See kybFormsRetrieve in the API Reference.
  • Form Update - Updates information on an existing Business verification form. See kybFormsUpdate in the API Reference.
  • Form Partial Update - Partially updates specific sections of an existing Business verification form. See kybFormsPartialUpdate in the API Reference.
It is possible to receive a list of Business verification forms associated with a particular token. There can be one or zero items in the list, indicating whether the form was or was not created.
  • List Business verification forms - Lists all forms associated with a particular token. See kybFormsList in the API Reference.

​
Documents

You can manage documents within the Business verification form/company. The following operations are available:
OperationDescriptionAPI Reference
List documentsLists all documents associated with the Business verification form/companykybFormsDocumentsList
Add documentUploads a new document to the Business verification form/companykybFormsDocumentsCreate
Retrieve documentRetrieves a specific document linked to the Business verification form/companykybFormsDocumentsRetrieve
Update documentUpdates an existing document within the Business verification form/companykybFormsDocumentsUpdate
Partial updatePartially updates a document in the Business verification form/companykybFormsDocumentsPartialUpdate
Delete documentDeletes a document associated with the Business verification form/companykybFormsDocumentsDestroy

​
Beneficiaries

You can manage beneficiaries within the Business verification form/company. The following operations are available:
OperationDescriptionAPI Reference
List beneficiariesLists all beneficiaries linked to the Business verification form/companykybFormsBeneficiariesList
Add beneficiaryAdds a new beneficiary to the Business verification form/companykybFormsBeneficiariesCreate
Retrieve beneficiaryRetrieves information on a specific beneficiarykybFormsBeneficiariesRetrieve
Update beneficiaryUpdates details of an existing beneficiarykybFormsBeneficiariesUpdate
Partial updatePartially updates information of a specific beneficiarykybFormsBeneficiariesPartialUpdate
Delete beneficiaryRemoves a beneficiary from the Business verification form/companykybFormsBeneficiariesDestroy

​
Beneficiaries’ Documents

You can manage beneficiaries’ documents using the following operations:
OperationDescriptionAPI Reference
List documentsLists all documents related to a specific beneficiarykybFormsBeneficiariesDocumentsList
Add documentUploads a new document for a beneficiarykybFormsBeneficiariesDocumentsCreate
Retrieve documentRetrieves a specific document associated with a beneficiarykybFormsBeneficiariesDocumentsRetrieve
Update documentUpdates an existing document for a beneficiarykybFormsBeneficiariesDocumentsUpdate
Partial updatePartially updates a beneficiary’s documentkybFormsBeneficiariesDocumentsPartialUpdate
Delete documentDeletes a document linked to a beneficiarykybFormsBeneficiariesDocumentsDestroy

​
Questionnaires

A questionnaire can be added to the flow. To check whether the form requires a questionnaire to be filled out, use the following endpoints:
  • Questionnaire list - Lists all available questionnaires associated with the Business verification form flow. See kybFormsQuestionnairesList in the API Reference.
  • Retrieve specific questionnaire - Retrieves a particular questionnaire within the Business verification process. See kybFormsQuestionnairesRetrieve in the API Reference.
If there is a need to fill it out, the following endpoints can be used:
OperationDescriptionAPI Reference
Update answersUpdates the answers to a questionnairekybFormsQuestionnairesAnswersUpdate
Retrieve answersRetrieves the answers provided in a questionnairekybFormsQuestionnairesAnswersRetrieve
List all answersRetrieves all completed questionnaire answers for a formkybFormsQuestionnairesAnswersDetailList
Delete answersDeletes answers provided in a questionnairekybFormsQuestionnairesAnswersDestroy

​
Form Submit

When the form is filled, it can be submitted. See kybFormsSubmitCreate in the API Reference.
Once the form is submitted, a webhook notification will be sent to your endpoint.