Search
K
gap-au-aml-customer-experience-standard v1

AML Verification API

v1OAS 3.0

Standard API for initiating AML verification

API Base URL
  • Server 1:https://api.pexaclear.com.au

    API Gateway URL

Security
oauth2 (oauth2)

Client Credentials OAuth Flow

Token URL: https://auth.pexa-group.com.au/oauth/token

Scopes:

  • x-api:initiate:verifications - Permission to initiate verifications
bearerAuth (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

CreateWorkspaceRequest

object
transactionTypestringrequired

Transaction type. Allowed values: AML

Match pattern:^(AML)$

externalReferencestring

Optional integrator-supplied reference for this workspace

<= 50 characters

Example:123e4567-e89b-12d3-a456-426614174000

settlementDatestring(date)
propertyobject
Show Child Parameters
partiesOne Of
arrayrequired

List of parties to be verified. Minimum 1 and maximum 30 parties per request.

>= 1 items<= 30 items

Variant 1One Of
Variant 1object
Show Child Parameters
Example

Property

object
addressobject
Show Child Parameters
Example

Address

object
unitNumberstring

<= 20 characters

streetNumberstringrequired

>= 1 characters<= 20 characters

streetNamestringrequired

>= 1 characters<= 100 characters

streetTypestringrequired

e.g. Street, Road, Avenue, Drive, Court

>= 1 characters<= 50 characters

suburbstringrequired

>= 1 characters<= 50 characters

statestringrequired

Australian state or territory code

Match pattern:^(NSW|VIC|QLD|WA|SA|TAS|ACT|NT)$

>= 2 characters<= 3 characters

postcodestringrequired

4-digit Australian postcode

Match pattern:^[0-9]{4}$

>= 4 characters<= 4 characters

Example

PartyRequest

object
partyTypestringrequired

Party type. Allowed values: INDIVIDUAL, ENTITY

Match pattern:^(INDIVIDUAL|ENTITY)$

rolestringrequired

Party role. Allowed values: BUYER, SELLER

Match pattern:^(BUYER|SELLER)$

Example