Skip to main content
POST
/
verifications
Create a verification
curl --request POST \
  --url https://app.ezyshield.com.au/api/verifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_name": "<string>",
  "account_bsb": "<string>",
  "account_number": "<string>",
  "business_name": "<string>",
  "business_abn": "<string>",
  "individual_name": "<string>",
  "individual_mobile": "<string>",
  "individual_email": "[email protected]",
  "send_individual_confirmation_sms": true,
  "send_individual_confirmation_email": true,
  "individual_portrait_image": "data:image/jpeg;base64,/9j/...",
  "attribution_id": "<string>",
  "accept_close_match": true
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "status": "<string>",
      "individual_confirmation_mode": "<string>",
      "send_individual_confirmation_sms": "<string>",
      "send_individual_confirmation_email": "<string>",
      "accept_close_match": "<string>",
      "attribution_id": "<string>",
      "individual_confirmation_url": "<string>",
      "failure_reason": "<string>",
      "check_results": {},
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
fields[verifications]
enum<string>[]
Available options:
status,
individual_confirmation_mode,
send_individual_confirmation_sms,
send_individual_confirmation_email,
accept_close_match,
attribution_id,
individual_confirmation_url,
failure_reason,
check_results,
created_at,
updated_at

Body

application/json
​
account_name
string
required

Bank account name.

Maximum string length: 255
​
account_bsb
string
required

Bank State Branch (BSB) code. Must be 6 digits.

​
account_number
string
required

Bank account number. Must be 6-10 digits.

​
business_name
string | null

Business name. When present, business_abn is required and business checks are run.

Maximum string length: 255
​
business_abn
string | null

Australian Business Number (ABN). Must be 11 digits. Required when business_name is present.

​
individual_name
string | null

Individual's full legal name. When present, individual confirmation mode is required and individual checks are run. Must include a space between first name(s) and last name (e.g., "John Michael Doe").

Maximum string length: 255
Pattern: ^[^\s]+\s+[^\s]+
​
individual_mobile
string | null

Individual's Australian mobile number. Required when send_individual_confirmation_sms is true.

The mobile number is also used for the individual's identity fingerprint. When successive verifications are requested via a common attribution_id and the individual_confirmation_mode is kyc, the mobile number is used to identify the individual. When the details have not changed, we fallback to biometric authentication for less friction, using the identification the individual provided in the last successful verification.

​
individual_email
string<email> | null

Individual's email address.

​
individual_confirmation_mode
enum<string>

Verification mode for the individual.

  • kyc: Run full KYC to establish identity (biometric authentication on subsequent verifications).
  • biometric: Biometric authentication with client-provided portrait image.
  • skip: Skip individual verification entirely. Required when individual_name is present. Must be omitted when individual_name is omitted.
Available options:
kyc,
biometric,
skip
​
send_individual_confirmation_sms
boolean

Whether to send the confirmation link to the individual via SMS. KYC and biometric verifications require at least one confirmation delivery channel. Must be omitted when individual_confirmation_mode is skip or when individual_name is omitted.

​
send_individual_confirmation_email
boolean

Whether to send the confirmation link to the individual via email. KYC and biometric verifications require at least one confirmation delivery channel. Must be omitted when individual_confirmation_mode is skip or when individual_name is omitted.

​
individual_portrait_image
string

Individual's government-issued ID portrait image. Required for biometric authentication when individual_confirmation_mode is biometric. The image must be a valid base64-encoded JPEG or PNG image up to 5MB when decoded. The data URI prefix data:[MIME type];base64, is optional.

Required when individual_confirmation_mode is biometric, otherwise it must be omitted.

Example:

"data:image/jpeg;base64,/9j/..."

​
attribution_id
string | null

Attribution identifier for grouping related verifications.

Maximum string length: 255
​
accept_close_match
boolean

Whether to accept close match results for verifications. When true, the bank account name check will pass on both exact match and close match results. Defaults to false.

Response

VerificationResource

​
data
VerificationResource · object
required