Unlocking access to the KYC forms

Use this API call to unlock access to a specific KYC form after expiration or too many failed verification attempts.

Parameters

NameTypeDescription
bronLink_verificationUuid (required)stringthe UUID of the verification to unlock

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

1
2
3
4
{
    "source": "bronid",
    "bronLink": "https://preview.bronid.com/idForm/02197017-1211-411b-8188-97f5144e65ef"
}

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
// api endpoint
const apiEndpoint = 'https://dev.bronid.com/idform';

// request body
const kycData = {
	// authorization
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "dev_secret_key",
	"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.