Skip to main content
POST
/
verifications
/
{verification}
/
cancel
Cancel a verification
curl --request POST \
  --url https://app.local-vj8qtz.ezyshield.com.au/api/verifications/{verification}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "status": "created",
      "business_name": "<string>",
      "business_abn": "<string>",
      "account_name": "<string>",
      "account_bsb": "<string>",
      "account_number": "<string>",
      "individual_name": "<string>",
      "individual_mobile": "<string>",
      "individual_confirmation_mode": "kyc",
      "send_individual_confirmation_sms": true,
      "accept_close_match": true,
      "attribution_id": "<string>",
      "individual_confirmation_url": "<string>",
      "failure_reason": "<string>",
      "checks": {},
      "resolved_individual_name": "<string>",
      "resolved_business_entity_name": "<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.

Path Parameters

​
verification
string<uuid>
required

The verification ID

Query Parameters

​
fields[verifications]
enum<string>[]
Available options:
status,
business_name,
business_abn,
account_name,
account_bsb,
account_number,
individual_name,
individual_mobile,
individual_confirmation_mode,
send_individual_confirmation_sms,
accept_close_match,
attribution_id,
individual_confirmation_url,
failure_reason,
checks,
resolved_individual_name,
resolved_business_entity_name,
created_at,
updated_at

Response

VerificationResource

​
data
VerificationResource · object
required