Quickstart
This guide will get you all set up and ready to use the bronID API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.
Before you can make requests to the bronID API, you will need to grab your API key from your dashboard. You can find it the bronID Portal under Settings » Developers » API keys.
Making your first API request
After picking your preferred client, you are ready to make your first call to the bronID API. Below, you can see how to submit verification data directly to bronID using the /v5/verifications endpoint. This approach is ideal when you have your own forms and want to collect customer data before sending it to bronID for verification.
Submit verification data
The examples below are runnable and include test environment credentials, so you can copy-paste to run them as is. Replace them with your own credentials and use the production server https://api.bronid.com when you're ready to go live.
curl -X POST https://dev.bronid.com/v5/verifications \
--user "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2:api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314" \
-H "Content-Type: application/json" \
--data '{
"userId": "test-user",
"onBehalfUid": "ABC",
"country": "AUS",
"type": "trust",
"subType": "discretionaryTrust",
"name": "Info trust name",
"industry": "Test Industry",
"website": "https://test.com",
"inputRisk": "unknown",
"identifiers": {
"abn": "12345678901"
},
"addresses": {
"registeredAddress": "123 Main St, Australia",
"principalPlaceOfBusiness": "123 Main St, Australia",
"other": "123 Main St, Australia"
},
"documents": [
{
"kind": "trustDeed",
"mimeType": "image/png",
"source": "base64",
"data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"description": "my description",
"fileName": "the file"
}
],
"stakeholders": [
{
"role": "trustee",
"entity": {
"type": "trust",
"subType": "unitTrust",
"country": "AUS",
"name": "Trustee Pty Ltd",
"identifiers": {
"abn": "123456789"
},
"addresses": {}
}
}
]
}'
What's next?
Great, you've now set up your with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the bronID API: