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

Passport

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

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" } }; // 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.