KYC verification of individuals
This specification is for the verification of individuals from the BRA, ESP, MEX. Use this API call to perform KYC verification of individuals.
Parameters
Name | Type | Description |
---|---|---|
country (required) | string | BRA, ESP, MEX |
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 |
address (required) | string | Address line 1 |
locality (required) | string | City / Locality |
postcode (required) | string | |
nationalId | string | National ID number |
gender | string | male/female/other/preferNotToSay |
phone | string | |
email | string |
Notes
The nationalId
is different for each country.
Country | National ID | Format |
---|---|---|
BRA | Natural Persons Register (CPF) | 11 digits (12345678909) |
ESP | National ID (DNI) | 9 characters |
MEX | Personal ID Code Number (CURP) | 18 characters (HEGG560427MVZRRL05) |
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.
Note on uploading documents: base64 encoded uploads must be submitted as a Data URI (with data format prefix). Example PDF format:
data:application/pdf;base64,JVBERi0xLjUKJYCBgoMKMSAwIG9i...
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",
"type": "individual",
"fields": {
"country": "ESP",
"firstName": "Jane",
"middleName": "ok",
"lastName": "Citizen",
"dateOfBirth": "20/10/1980",
"nationalId": "123456789",
"address": "Carrer del Doctor Giné i Partagàs",
"locality": "Barcelona",
"postcode": "08001",
"phone": "919932015",
"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);
}