Distributor KYC API
Use this API call to perform KYC verification on behalf of your customers.
This API has the same format as the regular KYC API, but it includes one extra parameter (metadata_onBehalf)
which is the UserId value of your onBehalf customer. Verifications submitted with this parameter will also be visible to your customers
through their portal account.
You can additionally use the metadata_tags param if you want to group the verifications.
The onBehalf and tags parameters can be used for filtering the verification and billing history.
Parameters
| Name | Type | Description |
|---|---|---|
metadata_onBehalf (required) | string | the UserId of your customer |
metadata_tags | string array | grouping tags |
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_onBehalf": "0cZ7Iz04oecZ7nNweGXHvoERjSk2", // replace with your customer service uid
"metadata_tags": ["tag1", "tag2"],
"type": "individual",
"fields": {
"country": "AUS",
"firstName": "Jane",
"middleName": "ok",
"lastName": "Citizen",
"gender": "female",
"dateOfBirth": "20/10/1980",
"unitNumber": "1",
"streetNumber": "95",
"streetName": "Lennox",
"streetType": "Street",
"suburb": "CASINO",
"postcode": "2470",
"state": "NSW",
"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);
}