Supplying additional information

When a customer does not provide sufficient information to complete the verification, we need to provide a way to ask the customer for additional details. This is done by running an API call which will unlock the form for the customer. When the customer opens the form, they will be asked to fill in the missing information to complete the verification. You should do this when you get an info webhook and your customer is ready to enter the information. To unlock the form you need to use the verificationUuid of the form you want to unlock. This form will have the same restrictions as the original form.

Note: The same API call is used to unlock an expired verification form.

Setting up a test example

You can setup a test example for supplying missing information if you submit a company with a name that starts with Info. When submitting with this keyword, it will put the entity in an info status and automatically reset the expiration time to 30 minutes. To expired the form without waiting you can access (refresh) the form 3 times. After you have submitted the entity and expired the form, come back and run the request bellow with the correct verificationUuid.

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

{
    "source": "bronid",
    "bronLink": "https://preview.bronid.com/idForm/02197017-1211-411b-8188-97f5144e65ef",
    "verificationUuid": "02197017-1211-411b-8188-97f5144e65ef",
    "status": "success"
}

Restrictions

  • URL is only accessible for a limited time (30 minutes) after generation
  • URL can only be opened 3 times
  • URL can be used for a maximum of 5 verification attempts

Runnable example

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

// request body
const kycData = {
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
	"metadata_version": "4",
	
	"bronLink_dataAccessType": "idForm",
	
	"bronLink_verificationUuid": "02197017-1211-411b-8188-97f5144e65ef"
};

// submit the KYC data to the bronID API
axios
	.post(apiEndpoint, kycData)
	.then(res => {
		// print the verification results
		console.log('click the results to expand them');
		console.log(JSON.stringify(res.data, null, 2));
	})
	.catch(error => {
		console.error(error)
	})
	
// Click “▶ run” to try this code live and run your first KYC.