BronID

Verify an individual (data)

Use POST /v5/verifications with type: "individual" and subType: "data" to submit a person's personal details, address, and optional identity documents directly. bronID validates the data server-side and starts verification immediately.

If you'd rather have the customer capture their own ID document and complete a liveness/biometrics check on a hosted link, use the Forms API: Verify an individual (eKYC).

Country-specific identity-document fields and per-state validations live on dedicated reference pages — see Identity documents (AUS) and Identity documents (NZL).

Request fields

  • Name
    userId
    Type
    string
    Description

    Optional. Your internal user identifier. Use this to track which of your users submitted the verification.

  • Name
    onBehalfUid
    Type
    string
    Description

    Optional. The UID of an onBehalf account if submitting on behalf of another organisation.

  • Name
    tags
    Type
    array
    Description

    Optional. Array of tag labels to attach to the verification for filtering and reporting. Use >>> (with surrounding spaces) to express hierarchy (e.g. tier-1 >>> gold). Up to 50 tags, each up to 500 characters. Labels referenced here are auto-registered into your tag registry on submission.

  • Name
    country
    Type
    string
    Description

    ISO3 Country code. Currently documented: AUS, NZL. See Countries for the full list.

  • Name
    type
    Type
    string
    Description

    Always "individual" for this flow.

  • Name
    subType
    Type
    string
    Description

    Always "data" for this flow.

  • Name
    firstName
    Type
    string
    Description

    Required. Given name.

  • Name
    middleName
    Type
    string
    Description

    Optional. Up to 50 characters.

  • Name
    lastName
    Type
    string
    Description

    Required. Family name.

  • Name
    email
    Type
    string
    Description

    Optional. Customer's email.

  • Name
    dateOfBirth
    Type
    string
    Description

    Required. Accepts YYYY-MM-DD (e.g. 1980-10-20) or DD/MM/YYYY (e.g. 20/10/1980). Normalised to YYYY-MM-DD server-side.

  • Name
    gender
    Type
    string
    Description

    Optional. Free-form string (e.g. male, female, other, preferNotToSay).

  • Name
    addresses.registeredAddress
    Type
    object
    Description

    Required. The customer's residential address. Required sub-fields depend on the country — see below.

  • Name
    identityDocuments
    Type
    array
    Description

    Optional. Array of structured ID documents (driver licence, passport, etc.). Each item's shape depends on country — see the per-country pages above.

  • Name
    documents
    Type
    array
    Description

    Optional. Array of file uploads (images, PDFs). See Include documents.

  • Name
    consent
    Type
    boolean
    Description

    Required. Must be the literal true. The customer must have agreed to the declaration on your data-collection page before you submit — see Identity documents (AUS) or Identity documents (NZL) for the exact wording.

addresses.registeredAddress by country

FieldAUSNZL
unitNumberoptionaloptional
streetNumberrequiredrequired
streetNamerequiredrequired
streetTypeoptionaloptional
cityrequiredrequired
postcoderequiredrequired
staterequirednot used

For AUS, state must be one of ACT, NSW, NT, QLD, SA, TAS, VIC, WA (case-insensitive).

principalPlaceOfBusiness and other follow the same schema and are always optional.

Example — AUS

Australian individual with a driver licence and consent.

Request

POST
/v5/verifications
curl https://dev.bronid.com/v5/verifications \
  --user "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2:api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314" \
  --header "Content-Type: application/json" \
  --data '{
      "userId": "user-aus-001",
      "country": "AUS",
      "type": "individual",
      "subType": "data",
      "firstName": "Janek",
      "middleName": "ok",
      "lastName": "Citizen",
      "dateOfBirth": "1980-10-20",
      "email": "janek@example.com",
      "addresses": {
        "registeredAddress": {
          "unitNumber": "1",
          "streetNumber": "95",
          "streetName": "Lennox",
          "streetType": "Street",
          "city": "Casino",
          "postcode": "2470",
          "state": "NSW"
        }
      },
      "identityDocuments": [
        {
          "kind": "driverLicence",
          "number": "12345678",
          "cardNumber": "1234567890",
          "state": "NSW"
        }
      ],
      "consent": true,
      "tags": ["region:apac", "tier-1 >>> gold"]
  }'

Example — NZL

New Zealand individual with a driver licence and consent.

Request

POST
/v5/verifications
curl https://dev.bronid.com/v5/verifications \
  --user "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2:api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314" \
  --header "Content-Type: application/json" \
  --data '{
      "userId": "user-nzl-001",
      "country": "NZL",
      "type": "individual",
      "subType": "data",
      "firstName": "Jane",
      "middleName": "ok",
      "lastName": "Citizen",
      "dateOfBirth": "1982-10-20",
      "email": "jane@example.com",
      "addresses": {
        "registeredAddress": {
          "unitNumber": "1",
          "streetNumber": "20",
          "streetName": "Karamu",
          "streetType": "Street",
          "city": "Taupo",
          "postcode": "3330"
        }
      },
      "identityDocuments": [
        {
          "kind": "driverLicence",
          "number": "AB123456",
          "versionNumber": "123"
        }
      ],
      "consent": true,
      "tags": ["region:apac", "tier-1 >>> gold"]
  }'

What's next?

Was this page helpful?