KYC verification of individuals (AUS)

Use this API call to perform KYC verification of individuals.

Parameters

Name	Type	Description
`country` (required)	string	3 letter country ISO
`firstName` (required)	string - letters only
`middleName` (required, if present)	string - letters only
`lastName` (required)	string - letters only
`gender` (required)	string	male/female
`dateOfBirth` (required)	string	DD/MM/YYYY
`unitNumber` (required, if present)	string
`streetNumber` (required)	string
`streetName` (required)	string
`streetType` (required)	string	Street types
`suburb` (required)	string
`postcode` (required)	string
`state` (required)	string	ACT / NSW / NT / QLD / SA / TAS / VIC / WA
`email`	string

ID documents

Submitting ID documents is optional. You can use ID documents as a verification source to improve the likelihood of a successful verification.

Driver licence

Name	Type	Description
`driversLicenceNumber` (required, if submitting)	string
`driversLicenceCardNumber` (required, if submitting)	string
`driversLicenceState` (required, if submitting)	string	ACT / NSW / NT / QLD / SA / TAS / VIC / WA
`driversLicenceImageFront`	string	base64 Data URI (JPG/PNG/PDF)
`driversLicenceImageBack`	string	base64 Data URI (JPG/PNG/PDF)

ACT driver's licence

Field	Requirement	Length/Format	Restrictions
Driver's Licence Number	Yes	Between 1 and 10 alphanumeric characters	No spaces or special characters
Driver's Licence Card Number	Yes	Equal to 10 alphanumeric characters
Given Name	Yes	Between 1 and 20 characters
Middle Name	No	Between 1 and 20 characters
Surname	Yes	Between 1 and 40 characters
Date of Birth	Yes	DD/MM/YYYY

NSW driver's licence

Field	Requirement	Length/Format	Restrictions
Driver's Licence Number	Yes	Between 1 and 10 alphanumeric characters	No spaces or special characters
Driver's Licence Card Number	Yes	Equal to 10 numeric characters
Given Name	Yes	Not exceeding 20 characters
Middle Name	No	Not exceeding 20 characters
Surname	Yes	Between 1 and 40 characters
Date of Birth	Yes	DD/MM/YYYY

NT driver's licence

Field	Requirement	Length/Format	Restrictions	Thumbnail
Driver's Licence Number	Yes	Between 1 and 10 alphanumeric characters	No spaces or special characters	Issued after Nov 2020 Issued before Nov 2020
Driver's Licence Card Number	Yes	Between 6 and 8 numeric characters		Issued after Nov 2020 Issued before Nov 2020
Given Name	Yes	Not exceeding 20 characters
Middle Name	No	Not exceeding 20 characters
Surname	Yes	Between 1 and 40 characters
Date of Birth	Yes	DD/MM/YYYY

QLD driver's licence

Field	Requirement	Length/Format	Restrictions	Thumbnail
Driver's Licence Number	Yes	Between 1 and 10 alphanumeric characters	No spaces or special characters
Driver's Licence Card Number	Yes	Equal to 10 alphanumeric characters		Front Back
Given Name	Yes	Not exceeding 20 characters
Middle Name	No	Not exceeding 20 characters
Surname	Yes	Between 1 and 40 characters
Date of Birth	Yes	DD/MM/YYYY

SA driver's licence

Field	Requirement	Length/Format	Restrictions
Driver's Licence Number	Yes	Between 1 and 10 alphanumeric characters	No spaces or special characters
Driver's Licence Card Number	Yes	Equal to 9 alphanumeric characters
Given Name	Yes	Not exceeding 20 characters
Middle Name	No	Not exceeding 20 characters
Surname	Yes	Between 1 and 40 characters
Date of Birth	Yes	DD/MM/YYYY

TAS driver's licence

Field	Requirement	Length/Format	Restrictions
Driver's Licence Number	Yes	Between 1 and 10 alphanumeric characters	No spaces or special characters
Driver's Licence Card Number	Yes	Equal to 9 alphanumeric characters
Given Name	Yes	Not exceeding 20 characters
Middle Name	No	Not exceeding 20 characters
Surname	Yes	Between 1 and 40 characters
Date of Birth	Yes	DD/MM/YYYY

VIC driver's licence

Field	Requirement	Length/Format	Restrictions
Driver's Licence Number	Yes	Between 1 and 10 alphanumeric characters	No spaces or special characters
Driver's Licence Card Number	Yes	Equal to 8 alphanumeric characters
Given Name	Yes	Not exceeding 20 characters
Middle Name	No	Not exceeding 20 characters
Surname	Yes	Between 1 and 40 characters
Date of Birth	Yes	DD/MM/YYYY

WA driver's licence

Field	Requirement	Length/Format	Restrictions
Driver's Licence Number	Yes	Between 1 and 10 alphanumeric characters	No spaces or special characters
Driver's Licence Card Number	Yes	Between 8 and 10 alphanumeric characters
Given Name	Yes	Not exceeding 20 characters
Middle Name	No	Not exceeding 20 characters
Surname	Yes	Between 1 and 40 characters
Date of Birth	Yes	DD/MM/YYYY

Passport

Name	Type	Description
`passportNumber` (required, if submitting)	string	Including any letters
`passportCountryOfIssue` (required, if submitting)	string	3 letter country ISO
`passportImage`	string	base64 Data URI (JPG/PNG/PDF)

Medicare

Name	Type	Description
`medicareCardColour` (required, if submitting)	string	green / blue / yellow
`medicareCardNumber` (required, if submitting)	string
`medicareIndividualReferenceNumber` (required, if submitting)	string
`medicareNameOnCard` (required, if submitting)	string	As it appears on the card
`medicareExpiryDate` (required, if submitting)	string	As it appears on the card (can be MM/YYYY, or DD/MM/YY depending card colour)
`medicareImage`	string	base64 Data URI (JPG/PNG/PDF)

Note

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 kycData = {
	"metadata_version": "4",
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
	"metadata_userId": "yourUniqueUserId",
	
	"type": "individual",
	"fields": {
		"country": "AUS",
		"firstName": "Jane",
		"middleName": "ok",
		"lastName": "Citizen",
		"gender": "female",
		"dateOfBirth": "20/10/1980",
		"unitNumber": "1",
		"streetNumber": "95",
		"streetName": "Lennox",
		"streetType": "Street",
		"suburb": "CASINO",
		"postcode": "2470",
		"state": "NSW",
		"email": "email@gmail.com"
	}
};

console.log('Running request...')

// submit the KYC data to the bronID API
const bronIdResult = await axios
	.post(apiEndpoint, kycData)
	.then(res => {
		return res.data;
	})
	.catch(error => {
		console.log('error! click the results to expand them');
		console.log(JSON.stringify(error.response.data, null, 2));
	})

const printResult = 'bronId API response: ' + JSON.stringify(bronIdResult, null, 2);
	
// Click “▶ run” to try this code live and run your first KYC.