KYC verification of individuals (USA)
Use this API call to perform KYC verification of individuals.
Parameters
| Name | Type | Description |
|---|---|---|
country (required) | string | USA |
firstName (required) | string - letters, apostrophes, spaces, hyphens | Less than 80 characters |
middleName (required, if present) | string - letters, apostrophes, spaces, hyphens | Less than 80 characters |
lastName (required) | string - letters, apostrophes, spaces, hyphens | Less than 80 characters |
dateOfBirth (required) | string | DD/MM/YYYY |
unitNumber (required, if present) | string or null* | |
streetNumber (required) | string | |
streetName (required) | string | |
streetType (required, if present) | string or null* | Street types |
suburb (required) | string | Suburb name |
postcode (required) | string | 5 digit postcode |
state (required) | string | 2 letter USA state abbreviation: AL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY |
socialSecurityNumber | string | 9 digits (XXX-XX-XXXX or XXXXXXXXX) |
gender | string | male/female/other/preferNotToSay |
phone | string | |
email | string |
Tags
You can add tags to your verification requests to help you organise your verifications by using the metadata_tags parameter. Read more about tags here.
Runnable example
POST
/verify// api endpoint
const apiEndpoint = 'https://dev.bronid.com/verify';
// request body
const data = {
"metadata_version": "4",
"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
"metadata_userId": "yourUniqueUserId",
"metadata_tags": ["product1", "client1"],
"type": "individual",
"fields": {
"country": "USA",
"firstName": "Jane",
"middleName": "ok",
"lastName": "Citizen",
"dateOfBirth": "20/10/1980",
"unitNumber": "",
"streetNumber": "250",
"streetName": "Point Lobos",
"streetType": "Ave",
"suburb": "San Francisco",
"postcode": "941211471",
"state": "CA",
"socialSecurityNumber": "123456789",
"phone": "0432248425",
"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);
}