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

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 accessible for a 31 days after generation (reduced prefilled data after 30 minutes)
• URL can be opened maximum 10 times without being saved
• 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"
};

console.log('Running request...')

// submit the KYC data to the bronID API
const bronIdResult = await axios
	.post(apiEndpoint, kycData)
	.then(res => {
		return res.data;
	})
	.catch(error => {
		console.log('error! click the results to expand them');
		console.log(JSON.stringify(error.response.data, null, 2));
	})

const printResult = 'bronId API response: ' + JSON.stringify(bronIdResult, null, 2);
	
// Click “▶ run” to try this code live and run your first KYC.