KYC verification of sole traders (NZL)
Use this API call to perform KYC verification of sole traders.
Parameters
| Name | Type | Description |
|---|---|---|
country (required) | string | NZL |
name (required) | string | |
nzbn (required) | string | 6-13 digits |
principalPlaceOfBusinessRequired (required) | string | address |
stakeholders (required) | array | individuals (*) |
Stakeholder types
| Name | Type | Note |
|---|---|---|
individuals | individual |
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
/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",
"type": "soleTrader",
"fields": {
"country": "NZL",
"name": "My Sole Trader",
"nzbn": "123456789",
"principalPlaceOfBusinessRequired": "1/20 Karamu Street, Taupo 3330"
},
"stakeholders": [
{
"type": "individual",
"role": "individuals",
"fields": {
"firstName": "Jane",
"middleName": "ok",
"lastName": "Citizen",
"gender": "female",
"dateOfBirth": "20/12/1982",
"unitNumber": "1",
"streetNumber": "20",
"streetName": "Karamu",
"streetType": "Street",
"suburb": "Taupo",
"postcode": "3330",
"email": "email@gmail.com",
"country": "NZL"
}
}
]
};
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);
}