v1

latestOpenAPI 3.1.02026-07-2496304466.3 KB
Accounts: ID+V

Submit Identification Payload

post/persons/{person_id}/identifications/{identification_id}/submit

Path parameters

identification_idstring required

An identifier referring to a person identification process.

person_idstring required

A person identifier.

Headers

LMG-Data-Privacy-Access-Principalstring required
LMG-Data-Privacy-Access-Justificationstring required

Request body

referencestring required

A reference to the ID+V process previously completed. The string must neither be empty and nor contain only whitespace characters.

completed_atstring date-time required

The point in time at which the ID+V process referenced by reference has been completed.

politically_exposed_personboolean

Indicate whether or not the person was identified as a politically exposed person (PEP).

Response

Successful Response

idstring required

The identifier referring to this person identification process.

method'kyc_reliance' required

A category representing the identification method used.

<ul> <li><code>kyc_reliance</code>: Use this for KYC reliance implementations. </ul>
status'created' | 'failed' | 'started' | 'succeeded' required

A category representing the status on a person identification process.

<ul> <li><code>created</code> <li><code>failed</code> <li><code>started</code> <li><code>succeeded</code> </ul>

Example response

{
  "history": [
    {
      "timestamp": "2023-06-23T07:29:55.465000+00:00"
    }
  ]
}