ID &V API

https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/
Admin
This guide helps users create an example ID proofing scenario using the ID &V API, enabling...
Tokens:66,685
Snippets:530
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Sample Response for Native SDK Session Start

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/liveness-detection

A sample response for starting a live capture video session with the native SDK. It provides the status, type, a portrait identifier, and the BioServer session identifier.

```JSON
{
  "status": "PROCESSING",
  "type": "PORTRAIT",
  "id": "12971f18-16ce-4a10-890a-bda5ffc7ecd7",
  "sessionId": "0851de47-b98e-4526-b049-cf20c1a3bc93"
}
```

--------------------------------

### Start Live Capture Video Session (Browser SDK)

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/liveness-detection

Use this request to start a live capture video session for liveness detection via a web browser. It extracts a user's face image for comparison with a reference portrait.

```Shell
curl -X POST \
  https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/attributes/portrait/capture-session?mode=webSDK \
  -H 'Content-Type: application/json' \
  -H 'apikey: [APIKEY_VALUE]'
```

--------------------------------

### Start live capture video session using a browser

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/liveness-detection

Initiates a live capture video session for liveness detection via a web SDK. The client application starts a video session to capture the user's face, which will be compared against a reference document's portrait. The response includes a BioServer session identifier for initializing the video stream.

```APIDOC
## POST /gips/v1/identities/[IDENTITY_ID]/attributes/portrait/capture-session?mode=webSDK

### Description
Starts a live capture video session for liveness detection using a web SDK. This captures the user's face for comparison with a reference document's portrait and provides a BioServer session identifier.

### Method
POST

### Endpoint
https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/attributes/portrait/capture-session?mode=webSDK

### Parameters
#### Query Parameters
- **mode** (string) - Required - Specifies the mode, expected to be 'webSDK'.

#### Path Parameters
- **IDENTITY_ID** (string) - Required - The identifier of the identity for which the portrait capture session is initiated.

#### Headers
- **apikey** (string) - Required - The API key for authentication.

### Request Example
```json
{
  "example": "curl -X POST \n  https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/attributes/portrait/capture-session?mode=webSDK \n  -H 'Content-Type: application/json' \n  -H 'apikey: [APIKEY_VALUE]'"
}
```

### Response
#### Success Response (200)
- **status** (string) - Status of the portrait capture session (e.g., "PROCESSING").
- **type** (string) - The type of evidence being captured (e.g., "PORTRAIT").
- **id** (string) - The user portrait identifier for future requests.
- **sessionId** (string) - The identifier to use during the video session with BioServer.

#### Response Example
```json
{
  "status": "PROCESSING",
  "type": "PORTRAIT",
  "id": "e7917cff-5727-4106-a756-1ddf4216aca6",
  "sessionId": "0991ced"
}
```
```

--------------------------------

### Sample Response for Browser SDK Session Start

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/liveness-detection

This is a sample response when initiating a live capture video session using the browser SDK. It includes status, type, an identifier, and a session ID for the BioServer.

```JSON
{
  "status": "PROCESSING",
  "type": "PORTRAIT",
  "id": "e7917cff-5727-4106-a756-1ddf4216aca6",
  "sessionId": "0991ced"
}
```

--------------------------------

### Start Live Capture Video Session (Native SDK)

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/liveness-detection

Initiate a live capture video session for liveness detection using a native SDK. This request extracts a face image and provides a session identifier for face capture.

```Shell
curl -X POST \
  https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/attributes/portrait/capture-session?mode=nativeSDK \
  -H 'Content-Type: application/json' \
  -H 'apikey: [APIKEY_VALUE]' \
  -d '{
	"type": "LIVENESS_PASSIVE_VIDEO"
}'
```

--------------------------------

### Retrieve Proof File

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/biometric-verification

Use this GET request to end the ID&V process and retrieve the generated archive file. This action discards PII. Ensure you have the identity ID and your API key.

```Shell
curl -X GET \
2https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/proof \
  -H 'apikey: [APIKEY_VALUE]' -o proof
```

--------------------------------

### Create Live Document Capture Video Session Request

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/live-document-capture

Starts a live capture video session for document image capture. This synchronous call returns a session identifier for the IDEMIA Document Capture SDK.

```Shell
curl -X POST \
https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/id-documents/live-capture-session \
-H 'Content-Type: application/json' \
-H 'apikey: [GIPS_RS_APIKEY_VALUE]' \
  -d '{
    "issuingCountry": "USA",
    "idDocumentType": "DRIVING_LICENSE",
    "sidesToCapture": [
        "FRONT","BACK"
    ]
}'
```

--------------------------------

### Start live capture video session using a native SDK

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/liveness-detection

Initiates a live capture video session for liveness detection via a native SDK. This captures the user's face for comparison with a reference document's portrait. The service provides a liveness session identifier to initiate face capture between the native SDK and the backend server. The request payload is optional.

```APIDOC
## POST /gips/v1/identities/[IDENTITY_ID]/attributes/portrait/capture-session?mode=nativeSDK

### Description
Starts a live capture video session for liveness detection using a native SDK. This captures the user's face for comparison with a reference document's portrait and provides a liveness session identifier.

### Method
POST

### Endpoint
https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/attributes/portrait/capture-session?mode=nativeSDK

### Parameters
#### Query Parameters
- **mode** (string) - Required - Specifies the mode, expected to be 'nativeSDK'.

#### Path Parameters
- **IDENTITY_ID** (string) - Required - The identifier of the identity for which the portrait capture session is initiated.

#### Headers
- **apikey** (string) - Required - The API key for authentication.

#### Request Body
- **type** (string) - Optional - Liveness type. Options include `LIVENESS_PASSIVE_VIDEO`, `LIVENESS_ACTIVE`, `LIVENESS_PASSIVE`, `LIVENESS_MLC` (BETA).
- **nbChallenge** (integer) - Optional - Number of user challenges for `LIVENESS_ACTIVE` type. Between 1 and 3. Defaults to 2.

### Request Example
```json
{
  "example": "curl -X POST \n  https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/attributes/portrait/capture-session?mode=nativeSDK \n  -H 'Content-Type: application/json' \n  -H 'apikey: [APIKEY_VALUE]' \n  -d '{ \n\t"type": \"LIVENESS_PASSIVE_VIDEO\"\n}'"
}
```

### Response
#### Success Response (200)
- **status** (string) - Status of the portrait's evidence (e.g., "PROCESSING").
- **type** (string) - Evidence type (e.g., "PORTRAIT").
- **id** (string) - The user portrait identifier for future requests.
- **sessionId** (string) - Identifier of the BioServer session.

#### Response Example
```json
{
  "status": "PROCESSING",
  "type": "PORTRAIT",
  "id": "12971f18-16ce-4a10-890a-bda5ffc7ecd7",
  "sessionId": "0851de47-b98e-4526-b049-cf20c1a3bc93"
}
```
```

--------------------------------

### GET Proof File

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/proof-specification

Retrieves the proof file for a given identity. This action closes the proofing session and returns a ZIP file embedded in a MIME envelope. The ZIP file contains various proof-related files and folders.

```APIDOC
## GET /gips/v1/identities/[IDENTITY_ID]/proof

### Description
Retrieves the proof file for a given identity. This request closes the proofing session and returns a ZIP file embedded in a MIME envelope. The ZIP file contains various proof-related files and folders.

### Method
GET

### Endpoint
https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/proof

### Parameters
#### Path Parameters
- **IDENTITY_ID** (string) - Required - This value should be the `id` value from the _Create Identity_ response message.

#### Query Parameters
None

#### Request Body
None

### Request Example
```shell
curl -X GET \
  https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/proof \
  -H 'apikey: [GIPS-RS_APIKEY_VALUE]' -o proof.tar.gz
```

### Response
#### Success Response (200)
Returns a ZIP file embedded in a MIME envelope. The ZIP file contains the following structure:
- **Root Folder**: Named after the identity ID and the timestamp of the proof generation (e.g., `gips-db676411-0329-4b13-ab7c-ee0adb6bb944_20171127144001086`).
  - **proof.json** (file) - Required - The main proof file referencing all other files and containing the signature.
  - **images** (folder) - Optional - Contains all images associated with the identity.
  - **videos** (folder) - Optional - Contains all videos associated with the identity (requires dedicated tenant configuration).
  - **additionalFiles** (folder) - Optional - Contains all additional files attached to the identity.
  - **identityDetails.json** (file) - Required - Details of the identity, same structure as `GET {API URL}/identities/{id}`.
  - **verificationAndEvaluationDetails.json** (file) - Required - Details about verifications performed and their contribution to the identity.

#### Response Example
(A MIME envelope containing a ZIP file. The content of the ZIP file is described above.)

### Error Handling
- **HTTP 403**: Forbidden if the status of the transaction is PROCESSING.
```

--------------------------------

### Retrieve Proof File

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/otp-phone-verification

Use this GET request to terminate the identity proofing process and retrieve an archive file containing all gathered and generated information. This action also triggers the deletion policy for gathered personal information.

```shell
curl -X GET \
2https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/proof \
3-H 'apikey: [APIKEY_VALUE]' -o proof
```

--------------------------------

### Example ID Verification Request

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1

This snippet demonstrates how to submit an ID document to the Web service for processing using a direct upload method. It includes the necessary headers and form data for uploading the document front, back, and capture details.

```APIDOC
## POST /gips/v1/identities/[IDENTITY_ID]/id-documents/capture

### Description
Submits an ID document to the ID&V service for processing via direct upload.

### Method
POST

### Endpoint
/gips/v1/identities/[IDENTITY_ID]/id-documents/capture

### Parameters
#### Path Parameters
- **IDENTITY_ID** (string) - Required - Value retrieved after performing Step 1. This should be the `id` value from the _Create Identity_ response message.

#### Headers
- **Content-Type**: multipart/form-data
- **apikey**: [APIKEY_VALUE] - Client application API key as provided by your Administrator(s)

#### Form Data
- **DocumentFront** (file) - Required - Absolute path to the local file for the front of the ID document (e.g., "C:\mydocumentfront.jpg").
- **DocumentBack** (file) - Optional - Absolute path to the local file for the back/reverse side of the ID document (e.g., "C:\mydocumentback.jpg"). This field is only mandatory in some use cases.
- **DocumentCaptureDetails** (file) - Optional - A JSON file containing specific information regarding the document being tested. Attaching this file can greatly improve the quality of the Service response.

##### DocumentCaptureDetails JSON Structure
{
  "jurisdiction": "[COUNTRY_CODE]",
  "documentType": "[DOCUMENT_TYPE]",
  "source": "[IMAGE_SOURCE]"
}

###### DocumentCaptureDetails Variables
- **COUNTRY_CODE** (string) - Alpha-3 code from ISO 3166-1 (e.g., USA for the United States, DEU for Germany).
- **DOCUMENT_TYPE** (string) - One of the supported document types (e.g., `PASSPORT`, `DRIVING_LICENSE`, `RESIDENT_CARD`, `IDENTITY_CARD`).
- **IMAGE_SOURCE** (string) - Information about how the image was captured: `LIVE_CAPTURE_IMAGE`, `LIVE_CAPTURE_VIDEO`, `SCAN`, or `OTHER`.

### Request Example
```
curl -X POST \
  https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/id-documents/capture \
  -H 'Content-Type: multipart/form-data' \
  -H 'apikey: [APIKEY_VALUE]' \
  -F 'DocumentFront=@[ABSOLUTE_LOCAL_PATH_TO_IDDOCUMENT_FRONT]' \
  -F 'DocumentBack=@[ABSOLUTE_LOCAL_PATH_TO_IDDOCUMENT_BACK]' \
  -F 'DocumentCaptureDetails=@[ABSOLUTE_LOCAL_PATH_TO_DOCUMENTCAPTUREDETAILS]'
```

### Response
#### Success Response (200)
- **status** (string) - Document status (e.g., "PROCESSING").
- **type** (string) - The document type (e.g., "PASSPORT").
- **id** (string) - The document identifier that will be used in all future requests.

#### Response Example
```json
{
  "status": "PROCESSING",
  "type": "PASSPORT",
  "id": "96541141-c44b-4606-9423-5e0486395b60"
}
```
```

--------------------------------

### Create live document capture video session

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/live-document-capture

Starts a live capture video session of the document to capture the best quality images. The service response provides a WebDoc Server session identifier.

```APIDOC
## POST /gips/v1/identities/[IDENTITY_ID]/id-documents/live-capture-session

### Description
Starts a live capture video session of the document to capture the best quality images. The service response provides a WebDoc Server session identifier to be used with the IDEMIA Document Capture SDK.

### Method
POST

### Endpoint
https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/id-documents/live-capture-session

### Headers
- Content-Type: application/json
- apikey: [GIPS_RS_APIKEY_VALUE]

### Request Body
- **issuingCountry** (String) - Optional - Alpha-3 code from ISO 3166-1 (e.g., USA for the United States, DEU for Germany)
- **idDocumentType** (String) - Optional - One of the supported document types. (Accepted values are `PASSPORT`, `DRIVING_LICENSE`, `RESIDENT_CARD`, `IDENTITY_CARD`, `TAX_CARD`, `VOTER_CARD`)
- **sidesToCapture** (String[]) - Optional - Contains list of document sides to capture. (Accepted values are `FRONT`, `BACK`)

### Request Example
```json
{
  "issuingCountry": "USA",
  "idDocumentType": "DRIVING_LICENSE",
  "sidesToCapture": [
    "FRONT",
    "BACK"
  ]
}
```

### Response
#### Success Response (200)
- **id** (String) - The document identifier that will be used in future requests (Check status).
- **status** (String) - Status of the portrait
- **sessionId** (String) - The document capture session identifier to be used with the IDEMIA Document Capture SDK.
- **type** (String) - The type of document to capture
- **sidesToCapture** (String[]) - The list of document sides to capture

### Response Example
```json
{
  "status": "PROCESSING",
  "type": "DRIVING_LICENSE",
  "id": "82a93866-36cb-4ccd-9e16-b9c20f18df99",
  "sessionId": "1324a525-f519-4698-99fc-2f1dbcad0223",
  "sidesToCapture": ["FRONT", "BACK"]
}
```
```

--------------------------------

### Example Proof Payload Structure

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/proof-specification

This JSON object represents an example of a proof payload. It includes version information, unique identifiers for the proof, identity, and tenant, transaction details, timestamps, component version, and cryptographic hashes of various data components. The 'signature' field contains the JWS signature.

```json
{
  "version": "1.0",
  "proofId": "********",
  "identityId": "********",
  "tenantId": "CUSTOM_NAME",
  "tenantRole": "RELYING_SERVICE",
  "transactionId": "********",
  "startDateTime": "2017-09-29T04:42:48.111",
  "endDateTime": "2017-09-29T04:59:57.575",
  "componentVersion": "1.0.0",
  "hashes": {
    "identityDetails": "********",
    "verificationAndEvaluationDetails": "********",
    "images": [
      {
        "id": "b35f7954",
        "path": "images/b35f7954.jpg",
        "hash": "********"
      },
      {
        "id": "7e435d21",
        "path": "images/7e435d21.jpg",
        "hash": "********"
      }
    ],
    "videos": [
      {
        "id": "ad3ea472",
        "path": "videos/ad3ea472.mp4",
        "hash": "********"
      },
      {
        "id": "2ceef228",
        "path": "videos/2ceef228.webm",
        "hash": "********"
      }
    ],
    "additionalFiles": [
      {
        "id": "3786ff22",
        "path": "additionalFiles/3786ff22.jpg",
        "hash": "********"
      },
      {
        "id": "a1262c99",
        "path": "additionalFiles/a1262c99.jpg",
        "hash": "********"
      }
    ]
  },
  "signature": "eyJhbGciOiJSUzI1NiJ9. InZlcnNpb24iOiIxLjAiLCJwcm9vZklkIjoiKioqKioqKioiLCJpZGVudGl0eUlkIjoiKioqKioqKioiLCJ0ZW5hbnRJZCI6IkNVU1RPTV9OQU1FIiwidHJhbnNhY3Rpb25JZCI6IioqKioqKioqIiwic3RhcnREYXRlVGltZSI6IjIwMTctMDktMjlUMDQ6NDI6NDguMTExIiwiZW5kRGF0ZVRpbWUiOiIyMDE3LTA5LTI5VDA0OjU5OjU3LjU3NSIsImNvbXBvbmVudFZlcnNpb24iOiIxLjAuMCIsImhhc2hzIjp7ImlkZW50aXR5RGV0YWlscyI6IioqKioqKioqIiwgICAgICAgICJ2ZXJpZmljYXRpb25BbmRFdmFsdWF0aW9uRGV0YWlscyI6IioqKioqKioqIiwiaW1hZ2VzIjpbe2lkOiAiMTIzNCIscGF0aDoiaW1hZ2VzLzEyMzQuanBnIixoYXNoOiIqKioqKioqKiJ9LHtpZDoiNDU2NyIscGF0aDoiaW1hZ2VzLzQ1NjcuanBnIiwgICAgICAgICAgICAgICAgaGFzaDoiKioqKioqKioifV0sInJlc3VtZURhdGEiOiIqKioqKioqKiJ9.IRMQENi4nJyp4er2LmZq3ivwoAjqa1uUkSBKFIX7ATndFF5ivnt+m8uApHO4kfIFOrW7w2Ezmlg3QdmaXlS9DhN0nUk/hGI3amEjkKd0BWYCB8vfUbUv0XGjQip78AI4z1PrFRNidm7+jPDm5Iq0SZnjKjCNS5Q15fokXZc8u0A="
}
```

--------------------------------

### Send Consent Response

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1

An example response after submitting a consent request. It confirms the approval status and type of consent provided, along with its validity period.

```JSON
[
  {
    "consentId": "be5d9a77-5706-41ff-b8d6-e14a555cb0a7",
    "approved": true,
    "type": "PORTRAIT",
    "validityPeriod": {
      "to": "2019-05-20"
    }
  }
]
```

--------------------------------

### Identity Status Response Example

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1

This JSON response provides the global status of the identity, including the Level of Assurance (LOA) and details of submitted ID documents.

```json
{
  "globalStatus": {
    "id": "afc85bca-d46c-4653-8053-1f4790f1a582",
    "status": "EXPECTING_INPUT",
    "levelOfAssurance": "LOA1"
  },
  "consents": [],
  "attributes": [],
  "addresses": [],
  "idDocuments": [
    {
      "evidenceId": "8c6240fd-6b48-4a97-a847-1ae7e8e96ccb",
      "submitDateTime": "2019-05-13T16:59:20.15",
      "type": "DRIVING_LICENSE",
      "evidenceStatus": {
        "evaluationDateTime": "2019-05-13T17:01:21.036",
        "status": "VERIFIED",
        "strength": "LEVEL3",
        "score": "LEVEL3"
      },
      "idDocumentData": {
        "idDocumentType": "DRIVING_LICENSE"
      }
    }
  ]
}
```

--------------------------------

### Check Identity Claim Status

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/otp-phone-verification

Use this GET request to check the processing status of a user's identity claim and their current level of assurance (LOA).

```shell
curl -X GET \
  https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/claim \
  -H 'Content-Type: application/json' \
  -H 'apikey: [APIKEY_VALUE]'
```

--------------------------------

### Create Live Document Capture Video Session Response

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/live-document-capture

Sample response for initiating a live document capture session. Includes the document identifier and a session ID for SDK initialization.

```JSON
{
  "status": "PROCESSING",
  "type": "DRIVING_LICENSE",
  "id": "82a93866-36cb-4ccd-9e16-b9c20f18df99",
  "sessionId": "1324a525-f519-4698-99fc-2f1dbcad0223",
  "sidesToCapture": ["FRONT", "BACK"]
}
```

--------------------------------

### Get Identity Proof

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1

Terminates the identity proofing process and retrieves all gathered and generated information as an archive file. This request is forbidden if the transaction status is PROCESSING.

```APIDOC
## GET /gips/v1/identities/[IDENTITY_ID]/proof

### Description
Terminates the proofing process and retrieves all information that the Service has gathered and generated. The client application receives an archive file in response. Getting the proof terminates the transaction and the Service applies the deletion policy to the personal information gathered during the session.

### Method
GET

### Endpoint
`https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/proof`

### Parameters
#### Path Parameters
- **IDENTITY_ID** (string) - Required - Value obtained after performing Step 1. This value should be the `id` value from the _Create Identity_ response message.

#### Query Parameters
None

#### Request Body
None

### Request Example
```shell
curl -X GET \
  https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/proof \
  -H 'apikey: [APIKEY_VALUE]' -o proof.tar.gz
```

### Request Variables
- **URL_MAIN_PART**: The Service domain
- **APIKEY_VALUE**: Client application API key as provided by your administrator(s)

### Response
#### Success Response (200)
- Returns an archive file (e.g., `proof.tar.gz`).

#### Response Example
(Archive file content not specified in source)
```

--------------------------------

### Check Identity Status Request

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1

This GET request retrieves the overall identity status and the achieved Level of Assurance (LOA). Include your API key for authentication.

```shell
curl -X GET \
https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID] \
-H 'Content-Type: application/json' \
-H 'apikey: [APIKEY_VALUE]'
```

--------------------------------

### Step 1: Create an Identity

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1

This request creates an identity for the provided user documents to initiate the verification process. It requires the service domain and an API key.

```APIDOC
## POST /gips/v1/identities

### Description
Creates an identity for the provided user documents to initiate the verification process.

### Method
POST

### Endpoint
https://[URL_MAIN_PART]/gips/v1/identities

### Headers
- **Content-Type**: multipart/form-data
- **apikey**: [APIKEY_VALUE]

### Request Example
```shell
curl -X POST https://[URL_MAIN_PART]/gips/v1/identities  \
  -H 'Content-Type: multipart/form-data' \
  -H 'apikey: [APIKEY_VALUE]'
```

### Response
#### Success Response (200)
- **id** (String) - The identity ID that will be used to identify the current transaction in other requests.
- **status** (String) - Status of the transaction
- **levelOfAssurance** (String) - Level of trust of current identity
- **creationDateTime** (Datetime) - Identity creation date
- **evaluationDateTime** (Datetime) - Last date on which the identity was evaluated
- **upgradePaths** (Object[]) - List of possible submissions that would increase LOA

#### Response Example
```json
{
	"id": "d4eee197-69e9-43a9-be07-16cc600d04e8",
	"status": "EXPECTING_INPUT",
	"levelOfAssurance": "LOA0",
	"creationDateTime": "2018-11-20T13:41:00.869",
	"evaluationDateTime": "2018-11-20T13:41:00.883",
	"upgradePaths": {}
}
```
```

--------------------------------

### Check Identity Status

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/biometric-verification

Use this GET request to check the current status and Level of Assurance (LOA) of an identity. Ensure you have the identity ID and your API key.

```Shell
curl -X GET \
  https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID] \
  -H 'Content-Type: application/json' \
  -H 'apikey: [APIKEY_VALUE]'
```

--------------------------------

### Check Document Status

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/live-document-capture

Use this GET request to poll the processing status of a captured document. The client application should continue polling until the status is no longer PROCESSING or ADJUDICATION.

```Shell
curl -X GET \
https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/status/[IDDOCUMENT_ID] \
	-H 'apikey: [GIPS_UA_APIKEY_VALUE]'
```

--------------------------------

### Check Document Status

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/nfc-documents

Use this GET request to check the processing status of a submitted ID document. The ID DOCUMENT ID is retrieved from the 'Evaluate an ID Document' response.

```shell
curl -X GET \
 https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/status/[IDDOCUMENT_ID] \
 -H 'apikey: [APIKEY_VALUE]'
```

--------------------------------

### Initialize NFC Document Authentication

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/nfc-documents

Initialize an NFC Document reading session by sending the Machine Readable Zone (MRZ) of an ID. This allows the NFC Document reading and authentication processes to start.

```shell
curl -X POST \
   http://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/id-documents/nfc-session \
   -H 'Content-Type: application/json' \
   -H 'apikey: [APIKEY_VALUE]' \
   -d '{
           "mrz": [
               "P<AUSHAPPY<CITIZEN<<FRED<WIREMU<JOHN<<<<<<"
           ]
       }'
```

--------------------------------

### Retrieve Proof File

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/proof-specification

Use this REST API endpoint to fetch the proof file. This request closes the proofing session. Ensure the transaction status is not PROCESSING to avoid an HTTP 403 error.

```Shell
curl -X GET \
  https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/proof \
  -H 'apikey: [GIPS-RS_APIKEY_VALUE]' -o proof.tar.gz
```

--------------------------------

### Retrieve User Portrait Capture Details

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/liveness-detection

Use this GET request to fetch a user's portrait capture details and verification results. Ensure you have the correct API key and identity ID.

```Shell
curl -X GET \
https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/attributes/portrait \
-H 'apikey: [APIKEY_VALUE]'
```

--------------------------------

### Retrieve Proof File

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/biometric-verification

Terminates the ID&V process and retrieves an archive file containing all gathered and generated information. This archive is intended for the client application to store as a reference for the user's identity.

```APIDOC
## GET /gips/v1/identities/[IDENTITY_ID]/proof

### Description
Terminates the Identity & Verification (ID&V) process and retrieves a proof archive file. This file contains all information gathered and generated during the ID&V process. ID&V discards all personally identifiable information after this retrieval.

### Method
GET

### Endpoint
/gips/v1/identities/[IDENTITY_ID]/proof

### Parameters
#### Path Parameters
- **IDENTITY_ID** (string) - Required - The unique identifier for the identity, retrieved from the 'Create Identity' response.

#### Headers
- **apikey** (string) - Required - The API key for authentication.

### Response
#### Success Response (200)
- **proof** (file) - An archive file containing the ID&V proof information.

### Notes
- The `URL_MAIN_PART` should be replaced with the actual ID&V domain.
- The `APIKEY_VALUE` is the client application's API key.
- The `IDENTITY_ID` is the value obtained after the 'Create Identity' step.
```

--------------------------------

### Retrieve Identity Verification Results

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/live-document-capture

This GET request retrieves the overall verification status of an identity, including the Level of Assurance (LOA) reached. It is useful for determining the final outcome of the verification process.

```Shell
curl -X GET \
https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID] \
	-H 'Content-Type: application/json' \
	-H 'apikey: [GIPS_UA_APIKEY_VALUE]'
```

--------------------------------

### Sample Response: Identity Claim Status (Configured Data)

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/otp-phone-verification

A sample JSON response for identity claim status, showing a configuration where some claim data might be hidden or summarized.

```json
{
  "globalStatus": {
    "id": "gips-cd46a451-60d2-4c25-a466-7af6518aad0b",
    "status": "EXPECTING_INPUT",
    "levelOfAssurance": "LOA2",
    "creationDateTime": "2023-11-10T21:28:47.991249",
    "evaluationDateTime": "2023-11-10T21:38:54.7148765",
    "nameReferenceEvidenceId": "440d8c98-f1f4-4c05-a3d8-6025faa3b967",
    "upgradePaths": {},
    "Claim": {
      "evidenceId": "440d8c98-f1f4-4c05-a3d8-6025faa3b967",
      "submitDateTime": "2023-11-10T21:38:51.8796052",
      "type": "ID_CLAIM"
    }
  }
}
```

--------------------------------

### Step 1: Create Identity

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/nist

Initiates a new identity verification session. This is the first step in the IAL2 workflow and returns an IDENTITY_ID required for subsequent calls.

```APIDOC
## POST /gips/v1/identities

### Description
Creates a new identity session for verification.

### Method
POST

### Endpoint
https://[URL_MAIN_PART]/gips/v1/identities

### Parameters
#### Headers
- **Content-Type**: multipart/form-data
- **apikey**: [APIKEY_VALUE] - Client application API key.

### Request Example
```
curl -X POST https://[URL_MAIN_PART]/gips/v1/identities \
-H 'Content-Type: multipart/form-data' \
-H 'apikey: [APIKEY_VALUE]'
```

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier for the created identity.

#### Response Example
```json
{
  "id": "[IDENTITY_ID]"
}
```
```

--------------------------------

### Ending the Process and Retrieving the Proof File

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/nfc-documents

This request terminates the proofing process and retrieves all gathered and generated information as an archive file. This file can be archived for audit purposes and used as a reference for the end-user's identity. Retrieving the proof terminates the transaction and initiates the deletion policy for personal information.

```APIDOC
## GET /gips/v1/identities/[IDENTITY_ID]/proof

### Description
Terminates the identity proofing process and retrieves the generated proof file.

### Method
GET

### Endpoint
https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/proof

### Parameters
#### Path Parameters
- **IDENTITY_ID** (string) - Required - Value obtained after performing Step 1. This value should be the `id` value from the _Create Identity_ response message.

#### Header Parameters
- **apikey** (string) - Required - Client application API key as provided by your administrator(s)

### Request Example
```shell
curl -X GET \
  https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/proof \
  -H 'apikey: [APIKEY_VALUE]' -o proof
```

### Response
#### Success Response (200)
- **proof** (archive file) - The archive file containing all gathered and generated identity information.
```

--------------------------------

### Check Mobile Contact Status

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/otp-phone-verification

Use this GET request to check the processing status of a user's mobile contact. Ensure you replace placeholders like [URL_MAIN_PART], [IDENTITY_ID], and [APIKEY_VALUE] with your actual values.

```Shell
curl -X GET https://[URL_MAIN_PART]/gips/v1/identities/[IDENTITY_ID]/contact-details/mobile \
  -H 'apikey: [APIKEY_VALUE]' \
  -H 'Content-Type: application/json'
```

--------------------------------

### Create an Identity Request

Source: https://experience.idemia.com/identity-proofing/develop/identity-proofing-verification/api-docs/1/live-document-capture

Initiates the verification process with ID&V. Requires the main domain and a Back End application API key.

```Shell
curl -X POST https://[URL_MAIN_PART]/gips/v1/identities \
  -H 'Content-Type: application' \
  -H 'apikey: [GIPS_RS_APIKEY_VALUE]'
```
Tokens:
Raw