bronID logobronID logo

eDocument KYC forms for individuals

Use this API call to generate eDocument KYC forms for individuals. These forms will allow your customers to submit at least two forms of ID, one of which will contain a photograph, and complete a liveness and biometrics check.

Parameters

NameTypeDescription
metadata_serviceUid (required)stringYour service unique identifier
metadata_secretKey (required)stringYour API secret key for authentication
metadata_version (required)stringAPI version (currently "4")
metadata_userIdstringYour unique user identifier
bronLink_dataAccessType (required)stringMust be "ekycForm" for eDocument KYC forms
type (required)string"individual"
firstName (required)stringCustomer's first name
lastName (required)stringCustomer's last name
email (required)stringCustomer's email address

Response

The response of the forms API contains the bronLink parameter. You can share this link with you customers via email, SMS or redirect them to the link from your app. The information you have submitted will be prefilled for them on the form. After they complete the verification you will receive a webhook with the verification status.

Response format

{
	"verificationUuid": "Xr8AFbtiiKBPjT9-qyegU",
	"bronLink": "{{unique eDocument KYC form link}}",
	"source": "bronid",
	"status": "success"
}

Tags

You can add tags to your verification requests to help you organise your verifications by using the metadata_tags parameter. Read more about tags here.

Note on uploading documents: base64 encoded uploads must be submitted as a Data URI (with data format prefix). Example PDF format:

data:application/pdf;base64,JVBERi0xLjUKJYCBgoMKMSAwIG9i...

Runnable example

POST
/idform
// api endpoint
const apiEndpoint = 'https://dev.bronid.com/idform';

// request body
const data = {
"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
"metadata_version": "4",
"metadata_userId": "your_unique_user_id",

"bronLink_dataAccessType": "ekycForm",
	
"type": "individual",
"fields": {
	"firstName": "Jane",
	"lastName": "Citizen",
	"email": "email@gmail.com"
}
};

try {
  const response = await fetch(apiEndpoint, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(data),
  });

  if (!response.ok) {
    const errorData = await response.json();
    console.log('error! click the results to expand them');
    console.log(JSON.stringify(errorData, null, 2));
  } else {
    const result = await response.json();
    const printResult = 'bronId API response: ' + JSON.stringify(result, null, 2);
    console.log(printResult);
  }
} catch (error) {
  console.log('Fetch error: ', error);
}