Verifications
You can use the /verification endpoints to manage verifications programmatically. We'll look at how to create and retrieve verifications.
Create a verification
This endpoint allows you to create a new KYB verification. Provide the entity details including type, identifiers, documents, and stakeholders.
Request body
- Name
userId- Type
- string
- Description
Optional. Your internal user identifier. Use this to track which of your users submitted the verification. Must be unique per verification.
- Name
onBehalfUid- Type
- string
- Description
Optional. The UID of an onBehalf account if submitting on behalf of another organization.
- Name
country- Type
- string
- Description
ISO3 Country code of the entity (e.g. AUS).
- Name
type- Type
- string
- Description
Entity type (e.g. trust).
- Name
subType- Type
- string
- Description
Entity sub-type (e.g. bareTrust).
- Name
name- Type
- string
- Description
Entity name.
- Name
industry- Type
- string
- Description
Industry description.
- Name
website- Type
- string
- Description
Entity website URL.
- Name
inputRisk- Type
- string
- Description
Risk level (e.g. unknown/low/medium/high).
- Name
identifiers- Type
- object
- Description
Entity identifiers keyed by scheme (e.g. abn, acn, etc.).
- Name
addresses- Type
- object
- Description
Entity addresses (e.g. registeredAddress, principalPlaceOfBusiness, etc.).
- Name
documents- Type
- array
- Description
Array of document objects with kind, mimeType, source, data, and optional description.
- Name
stakeholders- Type
- array
- Description
Array of stakeholder objects with role and entity details.
Request
curl https://dev.bronid.com/v5/verifications \
--user "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2:api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314" \
--header "Content-Type: application/json" \
--data '{
"country": "AUS",
"type": "trust",
"subType": "bareTrust",
"name": "My Trust",
"industry": "My industry",
"website": "https://bronid.com",
"inputRisk": "unknown",
"identifiers": {},
"addresses": {
"registeredAddress": "125 York St, Sydney, NSW, Australia"},
"documents": [
{
"kind": "trustDeed",
"mimeType": "application/pdf",
"source": "url",
"data": "https://example.com",
"description": ""
}
],
"stakeholders": [
{
"role": "trustee",
"entity": {
"type": "company",
"subType": "none",
"country": "AUS",
"name": "My Trustee",
"identifiers": {
"acn": "123456789"
},
"addresses": {
"registeredAddress": "125 York St, Sydney, NSW, Australia"
}
}
}
]
}'
Response
{
"timestamp": "2026-01-27T04:25:42.101Z",
"serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
"trace": "_mycHhuXA8vDMTgbCsqJf",
"path": "/v5/verifications",
"pathParams": {},
"statusCode": 200,
"message": "Verification created successfully",
"help": null,
"status": "success",
"data": null,
"error": null
}
Retrieve a verification
This endpoint allows you to retrieve detailed information about a verification by providing its trace identifier.
When to Use This Endpoint
Retrieve detailed verification data when you need to:
- Understand what additional information is required when
verificationStatusisinfo - Access rejection reasons when
verificationStatusisrejected - Retrieve complete entity data including all collected information, risk scores, and verification outcomes
Response Schema
The response structure varies based on the current verificationStatus. All responses share a common base structure, with additional fields included depending on the verification state.
Request
curl https://dev.bronid.com/v5/verifications/_mycHhuXA8vDMTgbCsqJf \
--user "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2:api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314"
Response
{
"timestamp": "2026-01-27T04:27:03.225Z",
"serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
"trace": "_mycHhuXA8vDMTgbCsqJf",
"path": "/v5/verifications/:trace",
"pathParams": { "trace": "_mycHhuXA8vDMTgbCsqJf" },
"statusCode": 200,
"message": "Verification details retrieved successfully.",
"help": null,
"status": "success",
"data": {
"trace": "_mycHhuXA8vDMTgbCsqJf",
"submissionId": "_mycHhuXA8vDMTgbCsqJf",
"country": "AUS",
"type": "trust",
"subType": "bareTrust",
"name": "My Trust",
"industry": "My industry",
"website": "https://bronid.com",
"identifiers": {},
"addresses": { "registeredAddress": "125 York St, Sydney, NSW, Australia" },
"inputRisk": "unknown",
"other": [],
"submissionStatus": "submitted",
"verificationStatus": "pending",
"message": "Verification is now pending.",
"timestamp": 1769487947878,
"idvRiskScore": "medium"
},
"error": null
}
The verification model
The verification model consists of several fixed properties (country, type, subType, name, industry, website), but also includes properies which depend on the country and entity type you are submitting (identifiers, addresses, stakeholders). Please look at the specific country and entity schemas for a detailed description.
Properties
- Name
country- Type
- string
- Description
ISO3 Country code of the entity (e.g. AUS).
- Name
type- Type
- string
- Description
Entity type (e.g. trust).
- Name
subType- Type
- string
- Description
Entity sub-type (e.g. bareTrust).
- Name
name- Type
- string
- Description
Entity name.
- Name
industry- Type
- string
- Description
Industry description.
- Name
website- Type
- string
- Description
Entity website URL.
- Name
inputRisk- Type
- string
- Description
Risk level (e.g. unknown/low/medium/high).
- Name
identifiers- Type
- object
- Description
Entity identifiers keyed by scheme.
- Name
addresses- Type
- object
- Description
Entity addresses.