KYC verification of partnerships (NZL)
Use this API call to perform KYC verification of partnerships.
Parameters
| Name | Type | Description |
|---|---|---|
country (required) | string | NZL |
name (required) | string | |
nzbn (required) | string | 6-13 digits |
principalPlaceOfBusinessRequired (required) | string | address |
partnershipAgreement (required) | string | base64 Data URI (JPG/PNG/PDF) |
stakeholders (required) | array | partners (*) |
Stakeholder types
| Name | Type | Note |
|---|---|---|
partners | individual | Individuals who are partners. In cases where the partners are organisations (e.g., companies, trusts, etc.), submit the ultimate beneficial owners and controllers of the partner organisations. |
Note on submitting stakeholders
For each company, the same individual can hold multiple stakeholder roles. For example, in a company, a person can be both a director and a shareholder. We strongly recommend submitting an individual in only one stakeholder role. If there is a specific role that must be included (i.e., is required), submit the individual in that role to avoid running multiple KYCs (identity verifications) for the same person within a single KYB, which would be redundant. This is a cost-effective approach. For instance, if John ok Citizen is both a director and shareholder of MY COMPANY, submit John ok Citizen as either a director or a shareholder, but not both. This will prevent duplicate charges for verification. Even if the individual is submitted under one role, bronID will map any additional relevant roles in the background and include them in the documentation.
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
// 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": "partnership",
"fields": {
"country": "NZL",
"name": "My Partnership",
"nzbn": "123456789",
"principalPlaceOfBusinessRequired": "1/20 Karamu Street, Taupo 3330",
"partnershipAgreement": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
},
"stakeholders": [
{
"type": "individual",
"role": "partners",
"fields": {
"firstName": "Jane",
"middleName": "ok",
"lastName": "Citizen",
"gender": "female",
"dateOfBirth": "12/12/1982",
"unitNumber": "1",
"streetNumber": "20",
"streetName": "Karamu",
"streetType": "Street",
"suburb": "Taupo",
"postcode": "3330",
"email": "email@gmail.com",
"country": "NZL"
}
},
{
"type": "individual",
"role": "partners",
"fields": {
"firstName": "Dave",
"middleName": "ok",
"lastName": "Citizen",
"gender": "male",
"dateOfBirth": "12/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);
}