latestSwagger 2.02026-08-1310101.9 MB

7da510b95492

Reliance onboarding

Create an onboarding application

Create an onboarding application and submit it for processing.

The request body must include a workflow-url to determine checks to be performed by the verification. The workflow specified determines which claims must exist for the subject profile, and any related profile (i.e. directors and people with significant control of a corporation).

At the moment we only support 3 reliance workflows: Reliance LTD Company, Reliance Individual and Reliance Sole Trader.

You need to provide different claims depending on the type of customer you wish to onboard via reliance.

LTD Company	Individual	Sole trader
Subject profile:<br>uk-company-register<br>trading-address<br>reliance-verification<br><br>Related profiles:<br>individual-identity<br>individual-residence<br>reliance-verification	Subject profile:<br>individual-identity<br>individual-residence<br>reliance-verification	Subject profile:<br>business-name<br>individual-identity<br>individual-residence<br>reliance-verification

For more information, check out our onboarding guides.

post/v0/organizations/{organization-id}/onboarding/applications

Path parameters

organization-idstring required

Request body

workflow-urlstring required

A link to the workflow.

Example request

{
  "workflow-url": "/v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA",
  "subject-profile": {
    "claims": [
      {
        "telephone-number": "+442012345678"
      }
    ]
  },
  "related-profiles": [
    {
      "subject-association": {
        "director": {
          "companies-house-url": "https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX"
        },
        "psc": {
          "ownership-percent": "12.34",
          "companies-house-url": "https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX"
        },
        "role-titles": [
          "Treasurer"
        ]
      },
      "claims": [
        {
          "telephone-number": "+442012345678"
        }
      ]
    }
  ]
}

Response

The created application

onboarding-application-urlstring required

Link to the onboarding application.

onboarding-application-status'processing' | 'submitted' | 'errored' | 'complete' required

Example response

{
  "onboarding-application-url": "/v0/onboarding/applications/oa.b25ib2FyZGluZy1hcHBsaQ"
}