v1

latestOpenAPI 3.0.1raw.githubusercontent.com2025-10-0765389.0 KB
Submit an application API

Submit an application API - Submit application creation requests for processing

post/v0/applications

Headers

Idempotency-Keystring required

Request body

Example request

{
  "data": {
    "applicants": [
      "customer"
    ],
    "bypass_validation": [
      {
        "validation_pointer": "/data/customer_reference"
      }
    ],
    "customer_reference": "anything_you_like_or_need",
    "application_lodger": {
      "email": "me@site.co.uk",
      "telephone": "+440000000000"
    }
  }
}

Response

Application creation request accepted

Example response

{
  "data": {
    "application_request_id": "12345678-1234-1234-1234-123546789abc"
  }
}