Include documents

You can include supporting documents when submitting entity verifications. Documents can be provided as URLs or base64-encoded content.

Document object structure

Each document in the documents array must include:

Field	Type	Required	Description
`kind`	string	Yes	The type of document (e.g., `partnershipAgreement`, `trustDeed`).
`mimeType`	string	Yes	The MIME type of the file (e.g., `application/pdf`, `image/png`).
`source`	string	Yes	How the document data is provided: `url` or `base64`.
`data`	string	Yes	The document data. Either a URL or base64-encoded content.
`fileName`	string	No	Original filename of the document.
`description`	string	No	Optional description of the document.

Some entity types have required documents, and the available document types vary by entity type. For example, a partnership requires a partnershipAgreement. If you submit a verification without the required document, you'll receive a validation error.

Validation error

{
  "timestamp": "2026-01-30T02:35:03.650Z",
  "serviceUid": "5qA5Hq0n1JQTY2TASItxYXSRyND3",
  "trace": "nwjUFDcaZl9gCSgtZfCM3",
  "path": "/v5/verifications",
  "statusCode": 422,
  "message": "Validation error",
  "help": null,
  "status": "error",
  "data": null,
  "error": {
    "type": "validation_error",
    "details": [
      {
        "message": "All required document types must have at least one document with file upload",
        "code": "custom",
        "path": ["documents"]
      }
    ]
  }
}

POST/v5/verifications

Example: Australian partnership

In this example, we will create a verification for an Australian general partnership. The partnershipAgreement document is required for partnerships, and we'll provide it as base64-encoded content.

Request body

Name
country
Type
string
Description
ISO3 Country code of the entity
Name
type
Type
string
Description
Entity type
Name
subType
Type
string
Description
Entity sub-type
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
IDV Risk level of the entity
Name
identifiers
Type
object
Description
Entity identifiers (ABN required for Australian partnerships)
Name
addresses
Type
object
Description
Entity addresses (principalPlaceOfBusiness required for partnerships)
Name
documents
Type
array
Description
Array of document objects (partnershipAgreement required)
Name
stakeholders
Type
array
Description
Array of stakeholder objects

Request

POST

/v5/verifications

curl https://dev.bronid.com/v5/verifications \
  --user "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2:api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314" \
  --header "Content-Type: application/json" \
  --data '{
      "country": "AUS",
      "type": "partnership",
      "subType": "generalPartnership",
      "name": "Smith & Jones Partnership",
      "industry": "Consulting",
      "website": "https://smithjones.com.au",
      "inputRisk": "low",
      "identifiers": {
        "abn": "12345678901"
      },
      "addresses": {
        "principalPlaceOfBusiness": "Level 10, 200 George St, Sydney NSW 2000"
      },
      "documents": [
        {
          "kind": "partnershipAgreement",
          "mimeType": "image/png",
          "source": "base64",
          "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
          "fileName": "partnership-agreement.png"
        }
      ],
      "stakeholders": []
  }'

Response

{
  "timestamp": "2026-01-30T02:35:42.101Z",
  "serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
  "trace": "_mycHhuXA8vDMTgbCsqJf",
  "path": "/v5/verifications",
  "pathParams": {},
  "statusCode": 200,
  "message": "Verification created successfully",
  "help": null,
  "status": "success",
  "data": null,
  "error": null
}

What's next?

Now that you know how to include documents, you can explore including stakeholders in your verification requests.