Get Person Identification

Get information about the identification process for a person.

get/persons/{person_id}/identifications/{identification_id}

Request

Base URL
https://sandbox.api.lemon.markets/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/lemon/apis/lemon-markets-brokerage-api/docs/persons/:person_id/identifications/:identification_id/get.ts
A function with typed inputs. Its response is checked against the schema.

identification_idstring required

An identifier referring to a person identification process.

person_idstring required

A person identifier.

LMG-Data-Privacy-Access-Principalstring required

LMG-Data-Privacy-Access-Justificationstring required

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>

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

No recorded changes to this operation across all 2 revisions of this API.