KYC forms for individuals (USA) - guide
This page contains only params relevant for the specific example. For a complete list of params for this API call visit this page.
Basic details verification
A basic details verification occurs when there are enough data sources to perform the KYC verification without government ID documents. Below is an example of a basic details verification.
Test values
In the test environment, you can trigger (fake) a basic details verification if you enter "OK" as the middle name of the person you are trying to verify. You can find all test values here.
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/5ae132d1-a4f6-4e72-adf4-92aa4faa39a3",
"verificationUuid": "5ae132d1-a4f6-4e72-adf4-92aa4faa39a3",
"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 data = {
"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
"metadata_version": "4",
"metadata_userId": "yourUniqueUserId",
"bronLink_dataAccessType": "idForm",
"type": "individual",
"fields": {
"country": "USA",
"firstName": "Jane",
"middleName": "ok",
"lastName": "Citizen",
"gender": "female",
"dateOfBirth": "20/10/1980",
"address": "250 Point Lobos Ave, San Francisco",
"email": "email@gmail.com"
}
};
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);
}