Getting started
PEXA Clear adheres to industry best practices to authenticate and authorise access to PEXA Clear APIs. PEXA Clear supports the Client Credentials OAuth 2.0 authentication method.
The OAuth 2.0 Client Credentials flow is designed for Machine-to-Machine (M2M) authentication. This method provides a way for applications or systems to securely authenticate and access APIs on behalf of the client application itself, rather than a specific user. Authentication is granted by passing an access token in the request header of the API. An access token is received by passing a series of client-specific credentials to the authentication server.
To authenticate using OAuth 2.0 Client Credentials, the client application needs to follow the steps outlined below.
- The client makes a request to the authorisation server sending the client ID, the client secret, along with the audience and other claims.
- The authorisation server validates the request, and, if successful, sends a response with an access token.
- The client can now use the access token to send requests to the resource server (i.e. the PEXA Clear API).
- The resource server sends back the response.
PEXA Clear API credentials are provided through the PEXA Clear registration and onboarding process.
If you require API client credentials, follow the instructions provided in the PEXA Clear Help Centre:
Registering for PEXA Clear – API Client Credentials
For assistance with credentials, authentication or environment access, contact PEXA Clear Support:
PEXA Clear Contact Support
- The PEXA Clear Integration Minimum Requirements outline the technical and security requirements that integration partners must meet to integrate with or access PEXA Clear APIs. Review the requirements here: PEXA Clear Integration Minimum Requirements
- PEXA's Cyber Security Policy outlines what is expected of everyone who interacts with PEXA Clear to help protect our data, devices and network. It applies to anyone who uses or has access to PEXA Clear's network or data. Read the External Information (Cyber) Security Policy