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

Name	Type	Description
`bronLink_verificationUuid` (required)	string	the UUID of the verification to unlock

This page is regarding the Forms API follow-up info request. If you are looking for the KYC API follow-up info request, you can find it here.

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

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",

  	"bronLink_dataAccessType": "idForm",

      /* this needs to match the verificationUuid with status info */
  	"bronLink_verificationUuid": "02197017-1211-411b-8188-97f5144e65ef"

};

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);
}