---
title: "Initiate AML Verification"
url: "https://apiportal.pexaclear.com.au/apis/gap-au-aml-customer-experience-standard-v1-v1/versions/9c31c4c2-000c-418b-ad44-c201d75d8af9/operations/initiateVerification"
---

> Full API specification: https://apiportal.pexaclear.com.au/apis/gap-au-aml-customer-experience-standard-v1-v1/versions/9c31c4c2-000c-418b-ad44-c201d75d8af9.md

# Initiate AML Verification

`POST` `/api/experience/v1/verifications`

Operation ID: `initiateVerification`

Initiates an AML verification by creating a workspace, triggering identity verification (IDV) and risk assessment for the specified parties.

## Request body (required)

Content types: `application/json`

## Responses

- `201` - Verification initiated successfully
- `400` - Bad request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not found
- `422` - Unprocessable entity - request payload failed validation
- `500` - Internal server error
- `501` - Not implemented - the requested functionality is not yet available

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: AML Customer Experience API
  version: v1
servers:
  - url: https://api.pexaclear.com.au
    description: API Gateway URL
paths:
  /api/experience/v1/verifications:
    post:
      summary: Initiate AML Verification
      operationId: initiateVerification
      tags:
        - Verification
      description: Initiates an AML verification by creating a workspace, triggering
        identity verification (IDV) and risk assessment for the specified
        parties.
      security:
        - oauth2:
            - x-api:initiate:verifications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - transactionType
                - parties
              properties:
                transactionType:
                  type: string
                  pattern: ^(AML)$
                  description: "Transaction type. Allowed values: AML"
                externalReference:
                  type: string
                  nullable: true
                  maxLength: 50
                  description: Optional integrator-supplied reference for this workspace
                  example: 123e4567-e89b-12d3-a456-426614174000
                settlementDate:
                  type: string
                  format: date
                  nullable: true
                property:
                  nullable: true
                  type: object
                  properties:
                    address:
                      nullable: true
                      type: object
                      required:
                        - streetNumber
                        - streetName
                        - streetType
                        - suburb
                        - state
                        - postcode
                      properties:
                        unitNumber:
                          type: string
                          nullable: true
                          maxLength: 20
                        streetNumber:
                          type: string
                          minLength: 1
                          maxLength: 20
                        streetName:
                          type: string
                          minLength: 1
                          maxLength: 100
                        streetType:
                          type: string
                          minLength: 1
                          maxLength: 50
                          description: e.g. Street, Road, Avenue, Drive, Court
                        suburb:
                          type: string
                          minLength: 1
                          maxLength: 50
                        state:
                          type: string
                          minLength: 2
                          maxLength: 3
                          pattern: ^(NSW|VIC|QLD|WA|SA|TAS|ACT|NT)$
                          description: Australian state or territory code
                        postcode:
                          type: string
                          minLength: 4
                          maxLength: 4
                          pattern: ^[0-9]{4}$
                          description: 4-digit Australian postcode
                parties:
                  type: array
                  minItems: 1
                  maxItems: 4
                  description: List of parties to be verified. Minimum 1 and maximum 4 parties per
                    request.
                  items:
                    oneOf:
                      - oneOf:
                          - allOf:
                              - allOf:
                                  - type: object
                                    discriminator:
                                      propertyName: partyType
                                      mapping:
                                        INDIVIDUAL: "#/components/schemas/IndividualPartyRequest"
                                        ENTITY: "#/components/schemas/EntityPartyRequest"
                                    required:
                                      - partyType
                                      - role
                                    properties:
                                      partyType:
                                        type: string
                                        pattern: ^(INDIVIDUAL|ENTITY)$
                                        description: "Party type. Allowed values: INDIVIDUAL, ENTITY"
                                      role:
                                        type: string
                                        pattern: ^(BUYER|SELLER)$
                                        description: "Party role. Allowed values: BUYER, SELLER"
                                      externalPartyId:
                                        type: string
                                        maxLength: 50
                                        nullable: true
                                        description: >
                                          Optional integrator-supplied
                                          identifier for this party. May be any
                                          string value up to 50 characters (for
                                          example, an identifier from your own
                                          system) — it does not need to be a
                                          UUID. If provided, it is echoed back
                                          in the corresponding party in the
                                          response so you can correlate your
                                          party to the PEXA partyId. Must be
                                          unique across the parties in the
                                          request. If omitted, only the
                                          PEXA-assigned partyId is returned for
                                          that party. It is recommended to
                                          always supply this value so party
                                          correlation is unambiguous.
                                        example: cust123
                                type: object
                                required:
                                  - partyType
                                  - familyName
                                  - partySubType
                                  - countryCode
                                  - mobileNumber
                                  - email
                                properties:
                                  partyType:
                                    type: string
                                    pattern: ^(INDIVIDUAL)$
                                  partySubType:
                                    type: string
                                    pattern: ^(SELF|SOLE_TRADER)$
                                    description: Subtype of the individual party. Use "SELF" for a standard
                                      individual or "SOLE_TRADER" for a sole
                                      trader.
                                  firstName:
                                    type: string
                                    nullable: true
                                    minLength: 1
                                    maxLength: 50
                                  middleNames:
                                    type: string
                                    nullable: true
                                    minLength: 1
                                    maxLength: 50
                                  familyName:
                                    type: string
                                    minLength: 1
                                    maxLength: 50
                                  dateOfBirth:
                                    type: string
                                    format: date
                                    nullable: true
                                  countryCode:
                                    type: string
                                    minLength: 1
                                    maxLength: 5
                                    pattern: ^\+[0-9]{1,4}$
                                    description: Country calling code, e.g. "+61"
                                    example: "+61"
                                  mobileNumber:
                                    type: string
                                    minLength: 8
                                    maxLength: 20
                                    pattern: ^[\d\s\-\+\(\)]{8,25}$
                                    description: Must contain between 8 and 20 digits
                                  email:
                                    type: string
                                    format: email
                                    maxLength: 320
                                    pattern: ^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
                                    description: Email address
                            type: object
                            required:
                              - partySubType
                            properties:
                              partySubType:
                                type: string
                                pattern: ^(SELF)$
                          - allOf:
                              - allOf:
                                  - type: object
                                    discriminator:
                                      propertyName: partyType
                                      mapping:
                                        INDIVIDUAL: "#/components/schemas/IndividualPartyRequest"
                                        ENTITY: "#/components/schemas/EntityPartyRequest"
                                    required:
                                      - partyType
                                      - role
                                    properties:
                                      partyType:
                                        type: string
                                        pattern: ^(INDIVIDUAL|ENTITY)$
                                        description: "Party type. Allowed values: INDIVIDUAL, ENTITY"
                                      role:
                                        type: string
                                        pattern: ^(BUYER|SELLER)$
                                        description: "Party role. Allowed values: BUYER, SELLER"
                                      externalPartyId:
                                        type: string
                                        maxLength: 50
                                        nullable: true
                                        description: >
                                          Optional integrator-supplied
                                          identifier for this party. May be any
                                          string value up to 50 characters (for
                                          example, an identifier from your own
                                          system) — it does not need to be a
                                          UUID. If provided, it is echoed back
                                          in the corresponding party in the
                                          response so you can correlate your
                                          party to the PEXA partyId. Must be
                                          unique across the parties in the
                                          request. If omitted, only the
                                          PEXA-assigned partyId is returned for
                                          that party. It is recommended to
                                          always supply this value so party
                                          correlation is unambiguous.
                                        example: cust123
                                type: object
                                required:
                                  - partyType
                                  - familyName
                                  - partySubType
                                  - countryCode
                                  - mobileNumber
                                  - email
                                properties:
                                  partyType:
                                    type: string
                                    pattern: ^(INDIVIDUAL)$
                                  partySubType:
                                    type: string
                                    pattern: ^(SELF|SOLE_TRADER)$
                                    description: Subtype of the individual party. Use "SELF" for a standard
                                      individual or "SOLE_TRADER" for a sole
                                      trader.
                                  firstName:
                                    type: string
                                    nullable: true
                                    minLength: 1
                                    maxLength: 50
                                  middleNames:
                                    type: string
                                    nullable: true
                                    minLength: 1
                                    maxLength: 50
                                  familyName:
                                    type: string
                                    minLength: 1
                                    maxLength: 50
                                  dateOfBirth:
                                    type: string
                                    format: date
                                    nullable: true
                                  countryCode:
                                    type: string
                                    minLength: 1
                                    maxLength: 5
                                    pattern: ^\+[0-9]{1,4}$
                                    description: Country calling code, e.g. "+61"
                                    example: "+61"
                                  mobileNumber:
                                    type: string
                                    minLength: 8
                                    maxLength: 20
                                    pattern: ^[\d\s\-\+\(\)]{8,25}$
                                    description: Must contain between 8 and 20 digits
                                  email:
                                    type: string
                                    format: email
                                    maxLength: 320
                                    pattern: ^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
                                    description: Email address
                            type: object
                            required:
                              - partySubType
                              - entityName
                              - mainBusinessLocation
                            properties:
                              partySubType:
                                type: string
                                pattern: ^(SOLE_TRADER)$
                              abn:
                                type: string
                                nullable: true
                                description: Australian Business Number (ABN) or Australian Company Number
                                  (ACN). Required when partySubType is
                                  SOLE_TRADER.
                              entityName:
                                type: string
                                minLength: 1
                                maxLength: 100
                                description: Trading entity name. Required when partySubType is SOLE_TRADER.
                              tradingName:
                                type: string
                                nullable: true
                                minLength: 1
                                maxLength: 100
                                description: Trading name or business name.
                              mainBusinessLocation:
                                type: string
                                minLength: 1
                                maxLength: 20
                                description: State and postcode. Required when partySubType is SOLE_TRADER.
                                example: SA 5045
                        discriminator:
                          propertyName: partySubType
                          mapping:
                            SELF: "#/components/schemas/IndividualSelfRequest"
                            SOLE_TRADER: "#/components/schemas/IndividualSoleTraderRequest"
                      - description: Entity party for AML verification (workspace creation). Supports
                          trusts, companies, partnerships, government bodies,
                          and other organisation types.
                        allOf:
                          - type: object
                            discriminator:
                              propertyName: partyType
                              mapping:
                                INDIVIDUAL: "#/components/schemas/IndividualPartyRequest"
                                ENTITY: "#/components/schemas/EntityPartyRequest"
                            required:
                              - partyType
                              - role
                            properties:
                              partyType:
                                type: string
                                pattern: ^(INDIVIDUAL|ENTITY)$
                                description: "Party type. Allowed values: INDIVIDUAL, ENTITY"
                              role:
                                type: string
                                pattern: ^(BUYER|SELLER)$
                                description: "Party role. Allowed values: BUYER, SELLER"
                              externalPartyId:
                                type: string
                                maxLength: 50
                                nullable: true
                                description: >
                                  Optional integrator-supplied identifier for
                                  this party. May be any string value up to 50
                                  characters (for example, an identifier from
                                  your own system) — it does not need to be a
                                  UUID. If provided, it is echoed back in the
                                  corresponding party in the response so you can
                                  correlate your party to the PEXA partyId. Must
                                  be unique across the parties in the request.
                                  If omitted, only the PEXA-assigned partyId is
                                  returned for that party. It is recommended to
                                  always supply this value so party correlation
                                  is unambiguous.
                                example: cust123
                          - description: Common entity (organisation) party fields shared by the
                              workspace-creation entity request and the
                              add-party entity request. Does not include the
                              discriminator base fields (partyType pattern /
                              role), which differ per usage and are supplied by
                              the referencing schema.
                            type: object
                            required:
                              - entityName
                              - mainBusinessLocation
                              - partySubType
                              - servicingMode
                            properties:
                              partySubType:
                                type: string
                                pattern: ^(TRUST|BODY_CORPORATE_COMPANY|PARTNERSHIP_ASSOCIATION|GOVERNMENT_BODY|OTHER)$
                                description: "Organisation subtype. Allowed values: TRUST,
                                  BODY_CORPORATE_COMPANY,
                                  PARTNERSHIP_ASSOCIATION, GOVERNMENT_BODY,
                                  OTHER"
                              partySubTypeDescription:
                                type: string
                                nullable: true
                                minLength: 3
                                maxLength: 100
                                pattern: ^[a-zA-Z0-9 \-&/()]+$
                                description: Required when partySubType is OTHER. Must not be provided
                                  otherwise.
                              servicingMode:
                                type: string
                                pattern: ^(SELF_SERVE|ASSISTED)$
                                description: "Servicing mode. Allowed values: SELF_SERVE, ASSISTED"
                              entityName:
                                type: string
                                minLength: 4
                                maxLength: 100
                              abn:
                                type: string
                                nullable: true
                                description: Australian Business Number (ABN) or Australian Company Number (ACN)
                              tradingName:
                                type: string
                                nullable: true
                                minLength: 1
                                maxLength: 100
                                description: Trading name or business name
                              mainBusinessLocation:
                                type: string
                                minLength: 6
                                maxLength: 8
                                pattern: ^[A-Z]{2,3} [0-9]{4}$
                                description: State and postcode in format 'STATE POSTCODE' (e.g. VIC 3000, NSW
                                  2000)
                                example: VIC 3000
                              primaryContact:
                                nullable: true
                                allOf:
                                  - type: object
                                    description: Primary contact for ASSISTED servicing mode. Required when
                                      servicingMode is ASSISTED.
                                    required:
                                      - familyName
                                      - mobile
                                      - email
                                    properties:
                                      firstName:
                                        type: string
                                        nullable: true
                                        minLength: 1
                                        maxLength: 50
                                        description: First name of the primary contact
                                      middleName:
                                        type: string
                                        nullable: true
                                        minLength: 1
                                        maxLength: 50
                                        description: Middle name of the primary contact
                                      familyName:
                                        type: string
                                        minLength: 1
                                        maxLength: 50
                                        description: Last name of the primary contact
                                      mobile:
                                        type: string
                                        pattern: ^\+[1-9]\d{6,14}$
                                        description: International mobile number
                                        example: "+61400000000"
                                      email:
                                        type: string
                                        format: email
                                        maxLength: 320
                                        pattern: ^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
                                        description: Email address
                                description: Required when servicingMode is ASSISTED. Contact details for the
                                  primary person managing the entity
                                  verification.
                        type: object
                        required:
                          - partyType
                        properties:
                          partyType:
                            type: string
                            pattern: ^(ENTITY)$
            examples:
              IndividualBuyerParty:
                summary: Create workspace with individual buyer (with externalPartyId)
                value:
                  transactionType: AML
                  externalReference: 123e4567-e89b-12d3-a456-426614174000
                  settlementDate: 2026-06-15
                  property:
                    address:
                      unitNumber: "4"
                      streetNumber: "12"
                      streetName: Collins
                      streetType: Street
                      suburb: Melbourne
                      state: VIC
                      postcode: "3000"
                  parties:
                    - partyType: INDIVIDUAL
                      externalPartyId: cust123
                      role: BUYER
                      familyName: Smith
                      firstName: Jane
                      middleNames: Marie
                      dateOfBirth: 1990-05-20
                      partySubType: SELF
                      countryCode: "+61"
                      mobileNumber: 412345678
                      email: jane.smith@example.com
              EntitySelfServeTrust:
                summary: Create workspace with self-serve trust entity
                value:
                  transactionType: AML
                  externalReference: trust-ref-001
                  settlementDate: 2026-07-01
                  property:
                    address:
                      streetNumber: "100"
                      streetName: Queen
                      streetType: Street
                      suburb: Melbourne
                      state: VIC
                      postcode: "3000"
                  parties:
                    - partyType: ENTITY
                      role: BUYER
                      entityName: Smith Family Trust
                      partySubType: TRUST
                      servicingMode: SELF_SERVE
                      abn: "53004087931"
                      tradingName: Smith Investments
                      mainBusinessLocation: VIC 3000
              EntityAssistedCompany:
                summary: Create workspace with assisted company entity
                value:
                  transactionType: AML
                  externalReference: company-ref-002
                  parties:
                    - partyType: ENTITY
                      role: SELLER
                      entityName: Acme Holdings Pty Ltd
                      partySubType: BODY_CORPORATE_COMPANY
                      servicingMode: ASSISTED
                      abn: "98765432100"
                      mainBusinessLocation: NSW 2000
                      primaryContact:
                        firstName: John
                        familyName: Smith
                        mobile: "+61400000000"
                        email: john@acmeholdings.com.au
              MultiPartyBuyerAndSeller:
                summary: Buyer (with externalPartyId) and seller entity (without)
                value:
                  transactionType: AML
                  externalReference: order-9981
                  parties:
                    - partyType: INDIVIDUAL
                      externalPartyId: cust123
                      role: BUYER
                      familyName: Smith
                      firstName: Jane
                      partySubType: SELF
                      countryCode: "+61"
                      mobileNumber: 412345678
                      email: jane.smith@example.com
                    - partyType: ENTITY
                      role: SELLER
                      entityName: Acme Holdings Pty Ltd
                      partySubType: BODY_CORPORATE_COMPANY
                      servicingMode: SELF_SERVE
                      abn: "98765432100"
                      mainBusinessLocation: NSW 2000
      responses:
        "201":
          description: Verification initiated successfully
          content:
            application/json:
              schema:
                type: object
                required:
                  - workspaceId
                  - parties
                properties:
                  workspaceId:
                    type: string
                    format: uuid
                  workspaceReference:
                    type: string
                    nullable: true
                  externalReference:
                    type: string
                    nullable: true
                    description: Integrator-supplied reference echoed from the request
                  workspaceUrl:
                    type: string
                    format: uri
                    nullable: true
                    description: URL to access the workspace in PEXA Clear
                  parties:
                    type: array
                    description: >
                      The parties created in the workspace during initiation.
                      Each entry includes the PEXA-assigned partyId, the
                      integrator-supplied externalPartyId (echoed back when
                      provided, otherwise null), and the party details. Use
                      partyId (or externalPartyId when supplied) to reference a
                      party in subsequent calls.
                    items:
                      type: object
                      required:
                        - partyId
                        - partyType
                        - role
                        - externalPartyId
                        - partyDetails
                      properties:
                        partyId:
                          type: string
                          format: uuid
                          description: PEXA-assigned party identifier
                        externalPartyId:
                          type: string
                          maxLength: 50
                          nullable: true
                          description: >
                            The integrator-supplied identifier echoed from the
                            request for this party. Null when no externalPartyId
                            was supplied for the party.
                          example: cust123
                        partyType:
                          type: string
                          enum:
                            - INDIVIDUAL
                            - ENTITY
                          description: Party type echoed from the request
                        role:
                          type: string
                          enum:
                            - BUYER
                            - SELLER
                          description: Party role echoed from the request
                        partyDetails:
                          type: object
                          additionalProperties: true
                          description: >
                            The submitted party details echoed back (e.g. names,
                            contact, entity information), so each returned party
                            is self-describing and can be matched to the party
                            you submitted.
              examples:
                IndividualBuyerResponse:
                  summary: Workspace with individual buyer party (externalPartyId echoed)
                  value:
                    workspaceId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    workspaceReference: PEXA210000012
                    externalReference: 123e4567-e89b-12d3-a456-426614174000
                    workspaceUrl: https://pexa.com.au/aml/workspaces/v1/a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    parties:
                      - partyId: f0e1d2c3-9b8a-7654-3210-fedcba987654
                        externalPartyId: cust123
                        partyType: INDIVIDUAL
                        role: BUYER
                        partyDetails:
                          firstName: Jane
                          familyName: Smith
                          partySubType: SELF
                          email: jane.smith@example.com
                          mobileNumber: "+610412345678"
                EntitySelfServeResponse:
                  summary: Workspace with self-serve entity party (no externalPartyId supplied)
                  value:
                    workspaceId: b2c3d4e5-f6a7-8901-bcde-f12345678901
                    workspaceReference: PEXA210000045
                    externalReference: trust-ref-001
                    workspaceUrl: https://pexa.com.au/aml/workspaces/v1/b2c3d4e5-f6a7-8901-bcde-f12345678901
                    parties:
                      - partyId: c1a2b3d4-1111-2222-3333-444455556666
                        externalPartyId: null
                        partyType: ENTITY
                        role: BUYER
                        partyDetails:
                          entityName: Smith Family Trust
                          partySubType: TRUST
                          servicingMode: SELF_SERVE
                          abn: "53004087931"
                          tradingName: Smith Investments
                          mainBusinessLocation: VIC 3000
                MultiPartyResponse:
                  summary: Buyer (externalPartyId echoed) and seller entity (null)
                  value:
                    workspaceId: b2c3d4e5-f6a7-8901-bcde-f12345678901
                    workspaceReference: PEXA210000045
                    externalReference: order-9981
                    workspaceUrl: https://pexa.com.au/aml/workspaces/v1/b2c3d4e5-f6a7-8901-bcde-f12345678901
                    parties:
                      - partyId: c1a2b3d4-1111-2222-3333-444455556666
                        externalPartyId: cust123
                        partyType: INDIVIDUAL
                        role: BUYER
                        partyDetails:
                          firstName: Jane
                          familyName: Smith
                          partySubType: SELF
                          email: jane.smith@example.com
                          mobileNumber: "+610412345678"
                      - partyId: d2b3c4e5-7777-8888-9999-aaaabbbbcccc
                        externalPartyId: null
                        partyType: ENTITY
                        role: SELLER
                        partyDetails:
                          entityName: Acme Holdings Pty Ltd
                          partySubType: BODY_CORPORATE_COMPANY
                          servicingMode: SELF_SERVE
                          abn: "98765432100"
                          mainBusinessLocation: NSW 2000
                EntityAssistedResponse:
                  summary: Workspace with assisted entity party
                  value:
                    workspaceId: c3d4e5f6-a7b8-9012-cdef-123456789012
                    workspaceReference: PEXA210000067
                    externalReference: company-ref-002
                    workspaceUrl: https://pexa.com.au/aml/workspaces/v1/c3d4e5f6-a7b8-9012-cdef-123456789012
                    parties:
                      - partyId: e5f6a7b8-2222-3333-4444-555566667777
                        externalPartyId: null
                        partyType: ENTITY
                        role: SELLER
                        partyDetails:
                          entityName: Acme Holdings Pty Ltd
                          partySubType: BODY_CORPORATE_COMPANY
                          servicingMode: ASSISTED
                          abn: "98765432100"
                          mainBusinessLocation: NSW 2000
                          primaryContact:
                            firstName: John
                            familyName: Smith
                            mobile: "+61400000000"
                            email: john@acmeholdings.com.au
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                        field:
                          type: string
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                        field:
                          type: string
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                        field:
                          type: string
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                        field:
                          type: string
        "422":
          description: Unprocessable entity - request payload failed validation
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                        field:
                          type: string
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                        field:
                          type: string
        "501":
          description: Not implemented - the requested functionality is not yet available
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                        field:
                          type: string
security:
  - oauth2:
      - x-api:initiate:verifications
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.pexa-group.com.au/oauth/token
          scopes:
            x-api:initiate:verifications: Permission to initiate verifications
            x-api:add:parties: Permission to add parties to an existing workspace
```
