Forms

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 on behalf of another organization.
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
stakeholders
Type
array
Description
Array of stakeholder objects with role and entity details.

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"
    }
  }'

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
}

Using the form URL

When you create a form, the response includes a formUrl that you can use to direct your customers to complete their verification.

Redirecting users

You can redirect users directly to the form URL:

// After creating a form, redirect the user
const formUrl = response.data.formUrl;
window.location.href = formUrl;

Embedding in an iframe

You can also embed the form in your application using an iframe:

<iframe src="https://forms-preview.bronid.com/ekyc-start/{trace}" width="100%" height="800" frameborder="0"></iframe>

Pre-filled data

Any data you provide in the request body will be pre-filled in the form. This includes:

Entity details (name, type, subType, country)
Identifiers (ABN, ACN, etc.)
Addresses
Stakeholder information

Pre-filling data reduces friction for your customers and ensures accuracy.

Form lifecycle

Create form - Call POST /v5/forms to generate a form URL
User completes form - Customer fills out remaining fields and submits
Verification starts - bronID processes the submission
Webhook notification - You receive status updates via webhooks

Form URLs are tied to a specific verification trace. Once a form is submitted, the URL will show the submission status rather than allowing re-submission.

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, stakeholders). 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.