Initiate KYX verification for a party.
POST/v1/parties/kyx
This endpoint initiates a KYX check against the specified party. In order to perform a KYX check, the party must satisfy the following criteria:
- Party must have provided the required details for their entity type:
Entity Type Requirements:
-
Individual:
- Full Legal Name (first, last, and any middle names)
- Date of Birth
- Registered/Residential Address (including street, suburb, state, postcode)
- Place of Birth (if available)
- Nationality
- Gender (if available)
-
Company:
- Registered Company Name
- ACN (Australian Company Number)
- ABN (Australian Business Number, if applicable)
- Incorporation Date
- Jurisdiction (state/territory)
- Registered Office Address
- Company Type (e.g., PROPRIETARY_LIMITED)
- Details of Directors and Shareholders
-
Trust:
- Trust Name
- Trust Type (e.g., discretionary, unit, SMSF)
- Establishment Date
- Jurisdiction
- Trust Deed Reference (if available)
- Trustee Details (individual or corporate)
- Beneficiary Details
- ABN (if conducting business)
-
Partnership:
- Partnership Name
- Partnership Type (e.g., general, limited)
- Establishment Date
- Jurisdiction
- Principal Place of Business
- Details of Partners
- ABN (if conducting business)
-
Sole Trader:
- Trading Name
- Business Description
- Commencement Date
- Principal Place of Business
- ABN
- Registered/Residential Address
Note: All entity types must provide sufficient identification and address information to satisfy Australian regulatory requirements for identity verification. Additional supporting documents may be required depending on the entity type and risk profile.
Request
Responses
- 200
- 400
- 401
- 403
- 422
- 500
- 501
- 503
The request was valid and able to be processed in some fashion. Results may or may not be successful, but it was completed as far as practical with no actual errors. Returns the check object as it stands now.
Unsupported entity type for request (PAR000003) or Unsupported address fields for KYX verification (PAR000008) or Schema validation error (GEN000000)
Missing or invalid authentication token (GEN001002) or Role unauthorized (GEN001006) or Tenant context could not be resolved (AUT001001)
External application access denied (AUT003001)
Capability not configured for this tenant (CRT022003) or Policy has no rule matching the request facts (CRT022002) or Invalid party status transition (PAR022001)
Internal server error (GEN100000). Service error (GEN100001). An error occurred while communicating with the identity verification connector (PAR100013).
Not Implemented - endpoint does not support the supplied entity type (GEN101007). Returned for SOLE_TRADER.
All connector targets are currently unhealthy (CRT103001)