Unlocking an expired form (>30 min)

Verification forms expire 31 days after their creation (reducec prefill data after 30 minutes) or when they're viewed 10 times. Once expired, you need to unlock the verification for your customers to be able to access the form. An unlocked form has the same restrictions as a new verification form. You can unlock the verification form with the Unlock API call.

Note: The same API call is used to provide additional information to a verification.

Setting up a test example

You can setup a test example for unlocking a verification form by generating a verification form and then try to access the form more than 10 times (refresh the page). This will automatically expire the verification form. You should then see an empty verification form which the customer can use, but will not have the ID fields prefilled. After you have expired the form, come back and run the request bellow with the correct

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.