KYC verification for 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
emailstring

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
driversLicenceState (required, if submitting)stringACT / NSW / NT / QLD / SA / TAS / VIC / WA
driversLicenceImageFrontstringbase64 document (JPG/PNG/PDF)
driversLicenceImageBackstringbase64 document (JPG/PNG/PDF)

Passport

NameTypeDescription
passportNumber (required, if submitting)stringIncluding any letters
passportCountryOfIssue (required, if submitting)string3 letter country ISO
passportImagestringbase64 document (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
medicareImagestringbase64 document (JPG/PNG/PDF)

Runnable example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
// api endpoint
const apiEndpoint = 'https://sandbox.bronid.com/verify';

// request body
const kycData = {
	// authorization
	"metadata_version": "4",
	"metadata_serviceUid": "RnbEhVfoQsec7mzehN4xgNA9uoi2",
	"metadata_secretKey": "dev_secret_key",
	"metadata_userId": "yourUniqueUserId",
	
	// individual details
	"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",
	},
};

// submit the KYC data to the bronID API
axios
	.post(apiEndpoint, kycData)
	.then(res => {
		// print the verification results
		console.log('click the results to expand them');
		console.log(JSON.stringify(res.data, null, 2));
	})
	.catch(error => {
		console.error(error)
	})
	
// Click “▶ run” to try this code live and run your first KYC.