Create a new verification

You can use the /forms endpoint to generate hosted, white-label ID forms.

POST/v5/forms

Create an ID form

This endpoint allows you to create a new ID form. Provide the entity details including type, subtype, identifiers and addresses.

Request body

Name
userId
Type
string
Description
Optional. Your internal user identifier. Use this to track which of your users submitted the verification. Must be unique per verification.
Name
onBehalfUid
Type
string
Description
Optional. The UID of an onBehalf account if submitting account-grouped verifications.
Name
country
Type
string
Description
ISO3 Country code of the entity (e.g. AUS).
Name
type
Type
string
Description
Entity type (e.g. trust).
Name
subType
Type
string
Description
Entity sub-type (e.g. bareTrust).
Name
name
Type
string
Description
Entity name.
Name
industry
Type
string
Description
Industry description.
Name
website
Type
string
Description
Entity website URL.
Name
inputRisk
Type
string
Description
Risk level (e.g. unknown/low/medium/high).
Name
identifiers
Type
object
Description
Entity identifiers keyed by scheme (e.g. abn, acn, etc.).
Name
addresses
Type
object
Description
Entity addresses (e.g. registeredAddress, principalPlaceOfBusiness, etc.).
Name
documents
Type
array
Description
Array of document objects with kind, mimeType, source, data, and optional description.
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.

For Australian and New Zealand entities, use the Lookup API before creating a form. It returns the entity name, identifiers, and the correct type and subType values from the registry, which you can pass directly into your form request.

Request

POST

/v5/forms

curl https://dev.bronid.com/v5/forms \
  --user "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2:api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314" \
  --header "Content-Type: application/json" \
  --data '{
    "country": "AUS",
    "type": "trust",
    "subType": "bareTrust",
    "name": "My Trust",
    "industry": "My industry",
    "website": "https://bronid.com",
    "inputRisk": "unknown",
    "identifiers": {
      "abn": "12345678901"
    },
    "tags": ["region:apac", "tier-1 >>> gold"]
  }'

Response

{
  "timestamp": "2026-01-27T04:34:37.668Z",
  "serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
  "trace": "1LuRUfAcaskosWc07nARZ",
  "path": "/v5/forms",
  "pathParams": {},
  "statusCode": 200,
  "message": "ID form created successfully",
  "help": null,
  "status": "success",
  "data": {
    "id": "1LuRUfAcaskosWc07nARZ",
    "formUrl": "https://forms-preview.bronid.com/ekyc-start/1LuRUfAcaskosWc07nARZ",
    "name": "My Trust",
    "help": null
  },
  "error": null
}

The verification model

The verification model consists of several fixed properties (country, type, subType, name, industry, website), but also includes properies which depend on the country and entity type you are submitting (identifiers, addresses). Please look at the specific country and entity schemas for a detailed description.

Properties

Name
country
Type
string
Description
ISO3 Country code of the entity (e.g. AUS).
Name
type
Type
string
Description
Entity type (e.g. trust).
Name
subType
Type
string
Description
Entity sub-type (e.g. bareTrust).
Name
name
Type
string
Description
Entity name.
Name
industry
Type
string
Description
Industry description.
Name
website
Type
string
Description
Entity website URL.
Name
inputRisk
Type
string
Description
Risk level (e.g. unknown/low/medium/high).
Name
identifiers
Type
object
Description
Entity identifiers keyed by scheme.
Name
addresses
Type
object
Description
Entity addresses.
Name
tags
Type
array
Description
Optional. Array of tag labels for filtering and reporting (e.g. ["region:apac", "tier-1 >>> gold"]).