KYC forms for government bodies (AUS)
Use this API call to generate KYC forms for government bodies.
Parameters
| Name | Type | Description |
|---|---|---|
country (required) | string | 3 letter country ISO |
type (required) | string | "governmentBody" |
abn | string | 11 digits |
name | string | |
address | string | |
legislationType | string | establishedUnderCommonwealthLegislation / establishedUnderStateTeritoryLegislation / other |
legislationName | string | |
website | string |
Response
The response of the forms API contains the bronLink parameter. You can share this link with you customers via email, SMS or redirect them to the link from your app. The information you have submitted will be prefilled for them on the form. After they complete the verification you will receive a webhook with the verification status.
Response format
{
"source": "bronid",
"bronLink": "https://preview.bronid.com/idForm/5ae132d1-a4f6-4e72-adf4-92aa4faa39a3",
"verificationUuid": "5ae132d1-a4f6-4e72-adf4-92aa4faa39a3",
"status": "success"
}
Restrictions
- URL is accessible for a 31 days after generation (reduced prefilled data after 30 minutes)
- URL can be opened maximum 10 times without being saved
- URL can be used for a maximum of 5 verification attempts
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
/idform// api endpoint
const apiEndpoint = 'https://dev.bronid.com/idform';
// request body
const data = {
"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
"metadata_version": "4",
"metadata_userId": "yourUniqueUserId",
"bronLink_dataAccessType": "idForm",
"type": "governmentBody",
"fields": {
"country": "AUS",
"name": "Pass My Govt Body",
"abn": "16123456789",
"address": "125 York St",
"legislationType": "other",
"legislationName": "legislation name",
"website": "https://www.gov.au"
}
};
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);
}