Retrieve verification status
Webhooks keep your system in sync with the status of the bronID verifications. You will receive a webhook every time there is a change in the verification status of your KYC entries.
The suggested way to get the status of a verification is to use the webhooks. This is because your compliance team might want to configure automated/scheduled actions in bronID which will trigger webhooks in case of changes. But in case of system limitations, you can also retrieve the latest webhook by calling the /getVerificationStatus endpoint.
You can look up the verification by using the trace or userId.
Parameters
Name | Type | Description |
---|---|---|
trace (required) | string | When looking up by trace |
userId (required) | string | When looking up by userId |
API call
POST
/getVerificationStatus// api endpoint
const apiEndpoint = 'https://dev.bronid.com/getVerificationStatus';
// request body
const data = {
"metadata_version": "4",
"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
// lookup by trace
"trace": "d8d8ce2a-e7a4-4919-b003-957b39b14f65"
// or by userId
// "userId": "myUserId"
};
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);
}
Sample response
{
"entityType": "privateCompany",
"name": "My Company",
"userId": "",
"verificationStatus": "verified",
"submissionStatus": "submitted",
"submissionId": "30793f2a-1ce8-43a1-ab74-65b041ce6bb2",
"trace": "30793f2a-1ce8-43a1-ab74-65b041ce6bb2",
"timestamp": 1732151352,
"idvRiskScore": {
"description": "Low to Medium"
},
"signature": {
"version": "1",
"keccak256": "bronid_sec_keccak256_7e4bc476c48b1c62c4e238b06737b42132a4a16fddc6682bd2c027eb79a1f054",
"sha256": "bronid_sec_sha256_cae93793a39b16e13da3c59c8a9afb2a27972f22fa5f7d07222dfc74e24797b6"
}
}