Skip to main content
POST
/
verifications
Create a verification
curl --request POST \
  --url https://api.staging-2tid4c.ezyshield.com.au/verification/v1/verifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_name": "<string>",
  "contact_name": "<string>",
  "contact_mobile": "<string>",
  "account_abn": "<string>",
  "account_name": "<string>",
  "account_bsb": "<string>",
  "account_number": "<string>",
  "business_phone": "<string>",
  "attribution_id": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "status": "created",
    "checks": [
      {
        "label": "<string>",
        "result": true
      }
    ],
    "attribution_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
business_name
string
required

The business name.

Maximum string length: 255
​
contact_name
string
required

The authorised contact's name. There must be a space between the first name(s) and last name, such as "John Michael Doe".

Maximum string length: 255
​
contact_mobile
string
required

The authorised contact's Australian mobile number.

​
account_abn
string
required

A valid 11-digit ABN.

​
account_name
string
required

The bank account name.

Maximum string length: 255
​
account_bsb
string
required

A valid 6-digit BSB.

​
account_number
string
required

A valid 6-10-digit account number.

​
business_phone
string | null

The business phone number.

Maximum string length: 255
​
attribution_id
string | null

An attribution ID. Used to group related verifications.

Maximum string length: 255

Response

VerificationResource

​
data
VerificationResource · object
required