Before you begin

Ensure you have the following prerequisites in place before starting your integration:

Item	Description
API Bearer Token	A valid token for authentication. Contact the *PCE Account Management team* to obtain one.
API Base URLs	Use the appropriate base URL depending on the environment you are integrating with. All API requests should be made relative to these URLs. Sandbox: Use `https://api.sandbox.prioritypassport.com` for development and testing. Production: Use `https://api.prioritypassport.com` for live transactions once your integration is approved.
Required Headers	Ensure that your API requests include the necessary headers. Example: `Authorization: Bearer <token>` `Content-Type: application/json`
Customer ID	Your unique `customer.id` assigned to account holder when Banking and Treasury service is opted for. If you already have an External reference ID, you can retrieve the corresponding `customer.id` using the GET `v1/customer/externalId/{externalId}` API endpoint. Alternatively, you can use the listing POST `v1/customer/list` API endpoint with filters such as `externalId`, `business.legalName`, or `individual.ssnLast4` to fetch the correct customer record. Contact the *PCE Account Management team* if you need assistance.
HTTPS	Your application must be served over HTTPS when making API requests in the production environment.

Creating Entities and Retrieving the Entity IDs

All entities in the system are created using an HTTP POST request.

When an entity is created successfully:

The API returns 201 Created.
The response header contains the URL of the newly created entity.
This URL includes the unique ID, which identifies the entity in the system.

You can use this URL to retrieve the complete details of the created entity.

Example:

POST /v1/customer/id/10293745/accounts

HTTP/1.1 201 Created
URL: /v1/customer/id/10293745/accounts/id/acc_123456789

In this example:

You can retrieve the entity using:

GET /v1/customer/id/10293745/accounts/id/acc_123456789

Tip: Always capture the entity ID returned in the Response header, as it is required for retrieving, updating, or deleting the entity later.