KYC verification of individuals (AUS)

Use this API call to perform KYC verification of individuals.

Parameters

NameTypeDescription
country
(required)		string3 letter country ISO
firstName
(required)		string - letters only
middleName
(required, if present)		string - letters only
lastName
(required)		string - letters only
gender
(required)		stringmale/female
dateOfBirth
(required)		stringDD/MM/YYYY
unitNumber
(required, if present)		string
streetNumber
(required)		string
streetName
(required)		string
streetType
(required)		stringStreet types
suburb
(required)		string
postcode
(required)		string
state
(required)		stringACT / 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

NameTypeDescription
driversLicenceNumber
(required, if submitting)		string
driversLicenceCardNumber
(required, if submitting)		string
driversLicenceState
(required, if submitting)		stringACT / NSW / NT / QLD / SA / TAS / VIC / WA
driversLicenceImageFront
stringbase64 Data URI (JPG/PNG/PDF)
driversLicenceImageBack
stringbase64 Data URI (JPG/PNG/PDF)

Licence number:

StateImage
ACTACT licence number
NSWNSW licence number
NTIssued after Nov 2020 NT licence number Issued before Nov 2020NT licence number
QLDQLD licence number
SASA licence number
TASTAS licence number
VICVIC licence number
WAWA licence number

Card number:

StateValidationImage
ACT10 alphanumeric charactersACT card number
NSW10 numeric charactersNSW card number
NTbetween 6 and 8 numeric charactersIssued after Nov 2020 NT card number Issued before Nov 2020NT card number
QLD10 alphanumeric charactersFront QLD card number Back QLD card number
SA9 alphanumeric charactersSA card number
TAS9 alphanumeric charactersTAS card number
VIC8 alphanumeric charactersVIC card number
WAbetween 8 and 10 alphanumeric charactersWA card number

Passport

NameTypeDescription
passportNumber
(required, if submitting)		stringIncluding any letters
passportCountryOfIssue
(required, if submitting)		string3 letter country ISO
passportImage
stringbase64 Data URI (JPG/PNG/PDF)

Medicare

NameTypeDescription
medicareCardColour
(required, if submitting)		stringgreen / blue / yellow
medicareCardNumber
(required, if submitting)		string
medicareIndividualReferenceNumber
(required, if submitting)		string
medicareNameOnCard
(required, if submitting)		stringAs it appears on the card
medicareExpiryDate
(required, if submitting)		stringAs it appears on the card (can be MM/YYYY, or DD/MM/YY depending card colour)
medicareImage
stringbase64 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.