Get an application

{
  "success": true,
  "message": "Application retrieved successfully",
  "traceId": "0HNNNPRPLVN3H:00000009",
  "data": {
    "requestsReference": "3f3caa7b-bdfe-4bf1-814b-30d54859247c",
    "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
    "applicationStatus": "draft",
    "applicationStatusCode": 1,
    "allowedActions": [
      "submit",
      "withdraw",
      "abandon"
    ],
    "createdAt": "2026-07-01T15:00:01.734346",
    "_links": {
      "self": "/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c",
      "business": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
    },
    "paypointReference": "019ff064-c690-7679-a73e-688418aadc7c",
    "paypointStatus": "pending",
    "externalId": "APP-2025-0417",
    "tags": [
      "priority"
    ]
  }
}

Retrieves a boarding application by reference.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

requestsReferencestringRequired

The application reference.

Response

The application.

successboolean

Whether the request succeeded.

messagestring or null

A human-readable result message.

traceIdstring or null

The trace identifier for the request, useful for support.

dataobject or null

The application.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error