7.3.4. Enrollment¶

Get the OpenAPI file for this interface: enrollment.yaml

7.3.4.1. Services¶

7.3.4.1.1. Enrollment¶

POST /v1/enrollments/{enrollmentId}¶

Create one enrollment

Scope required: enroll.write

Query Parameters:
Parameters:	enrollmentId (string) – the id of the enrollment
	finalize (boolean) – Flag to indicate that data was collected (default is false). transactionId (string) – The id of the transaction (Required)
Status Codes:	201 Created – Operation successful 400 Bad Request – Bad request 403 Forbidden – Operation not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/enrollments/{enrollmentId}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json
Authorization: Bearer cn389ncoiwuencr

{
    "enrollmentId": "string",
    "status": "FINALIZED",
    "enrollmentType": "string",
    "enrollmentFlags": [
        {
            "timeout": 3600,
            "other": "other"
        }
    ],
    "requestData": [
        {
            "requestType": "IDCARD_ISSUANCE",
            "deliveryPlace": "paris",
            "other": "other"
        }
    ],
    "biographicData": {
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA"
    },
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "mimetype": "string",
            "resolution": 1,
            "compression": "NONE"
        }
    ],
    "documentData": [
        {
            "documentType": "ID_CARD",
            "instance": "string",
            "parts": [
                {
                    "pages": [
                        1
                    ],
                    "data": "c3RyaW5n",
                    "dataRef": "https://example.com",
                    "width": 1,
                    "height": 1,
                    "captureDate": "2020-07-01",
                    "captureDevice": "string",
                    "mimetype": "string"
                }
            ]
        }
    ]
}

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
    "enrollmentId": "string"
}

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

GET /v1/enrollments/{enrollmentId}¶

Read one enrollment

Scope required: enroll.read

Query Parameters:
Parameters:	enrollmentId (string) – the id of the enrollment
	transactionId (string) – The id of the transaction (Required) attributes (array) – The (optional) set of required attributes to retrieve. If not present all attributes will be returned.
Status Codes:	200 OK – Read successful 400 Bad Request – Bad request 403 Forbidden – Read not allowed 404 Not Found – Unknown record 500 Internal Server Error – Unexpected error

Example request:

GET /v1/enrollments/{enrollmentId}?transactionId=string HTTP/1.1
Host: example.com
Authorization: Bearer cn389ncoiwuencr

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "enrollmentId": "string",
    "status": "FINALIZED",
    "enrollmentType": "string",
    "enrollmentFlags": [
        {
            "timeout": 3600,
            "other": "other"
        }
    ],
    "requestData": [
        {
            "requestType": "IDCARD_ISSUANCE",
            "deliveryPlace": "paris",
            "other": "other"
        }
    ],
    "biographicData": {
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA"
    },
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "mimetype": "string",
            "resolution": 1,
            "compression": "NONE"
        }
    ],
    "documentData": [
        {
            "documentType": "ID_CARD",
            "instance": "string",
            "parts": [
                {
                    "pages": [
                        1
                    ],
                    "data": "c3RyaW5n",
                    "dataRef": "https://example.com",
                    "width": 1,
                    "height": 1,
                    "captureDate": "2020-07-01",
                    "captureDevice": "string",
                    "mimetype": "string"
                }
            ]
        }
    ]
}

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

PUT /v1/enrollments/{enrollmentId}¶

Update one enrollment

Scope required: enroll.write

Query Parameters:
Parameters:	enrollmentId (string) – the id of the enrollment
	finalize (boolean) – Flag to indicate that data was collected (default is false). transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Update successful 400 Bad Request – Bad request 403 Forbidden – Update not allowed 404 Not Found – Unknown record 500 Internal Server Error – Unexpected error

Example request:

PUT /v1/enrollments/{enrollmentId}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json
Authorization: Bearer cn389ncoiwuencr

{
    "enrollmentId": "string",
    "status": "FINALIZED",
    "enrollmentType": "string",
    "enrollmentFlags": [
        {
            "timeout": 3600,
            "other": "other"
        }
    ],
    "requestData": [
        {
            "requestType": "IDCARD_ISSUANCE",
            "deliveryPlace": "paris",
            "other": "other"
        }
    ],
    "biographicData": {
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA"
    },
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "mimetype": "string",
            "resolution": 1,
            "compression": "NONE"
        }
    ],
    "documentData": [
        {
            "documentType": "ID_CARD",
            "instance": "string",
            "parts": [
                {
                    "pages": [
                        1
                    ],
                    "data": "c3RyaW5n",
                    "dataRef": "https://example.com",
                    "width": 1,
                    "height": 1,
                    "captureDate": "2020-07-01",
                    "captureDevice": "string",
                    "mimetype": "string"
                }
            ]
        }
    ]
}

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

PATCH /v1/enrollments/{enrollmentId}¶

Update partially one enrollment

Update partially an enrollment. Payload content is a partial enrollment object compliant with RFC7396.

Scope required: enroll.write

Query Parameters:
Parameters:	enrollmentId (string) – the id of the enrollment
	finalize (boolean) – Flag to indicate that data was collected (default is false). transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Update successful 400 Bad Request – Bad request 403 Forbidden – Update not allowed 404 Not Found – Unknown record 500 Internal Server Error – Unexpected error

Example request:

PATCH /v1/enrollments/{enrollmentId}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json
Authorization: Bearer cn389ncoiwuencr

{
    "enrollmentId": "string",
    "status": "FINALIZED",
    "enrollmentType": "string",
    "enrollmentFlags": [
        {
            "timeout": 3600,
            "other": "other"
        }
    ],
    "requestData": [
        {
            "requestType": "IDCARD_ISSUANCE",
            "deliveryPlace": "paris",
            "other": "other"
        }
    ],
    "biographicData": {
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA"
    },
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "mimetype": "string",
            "resolution": 1,
            "compression": "NONE"
        }
    ],
    "documentData": [
        {
            "documentType": "ID_CARD",
            "instance": "string",
            "parts": [
                {
                    "pages": [
                        1
                    ],
                    "data": "c3RyaW5n",
                    "dataRef": "https://example.com",
                    "width": 1,
                    "height": 1,
                    "captureDate": "2020-07-01",
                    "captureDevice": "string",
                    "mimetype": "string"
                }
            ]
        }
    ]
}

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

DELETE /v1/enrollments/{enrollmentId}¶

Delete one enrollment

Scope required: enroll.write

Query Parameters:
Parameters:	enrollmentId (string) – the id of the enrollment
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Delete successful 400 Bad Request – Bad request 403 Forbidden – Operation not allowed 500 Internal Server Error – Unexpected error

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

PUT /v1/enrollments/{enrollmentId}/finalize¶

Finalize one enrollment

Scope required: enroll.write

Query Parameters:
Parameters:	enrollmentId (string) – the id of the enrollment
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Update successful 400 Bad Request – Bad request 403 Forbidden – Update not allowed 404 Not Found – Unknown record 500 Internal Server Error – Unexpected error

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

POST /v1/enrollments¶

Retrieve a list of enrollments which match passed in search criteria

Scope required: enroll.read

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	200 OK – Read successful 400 Bad Request – Bad request 403 Forbidden – Read not allowed 404 Not Found – Unknown record 500 Internal Server Error – Unexpected error

Example request:

POST /v1/enrollments?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json
Authorization: Bearer cn389ncoiwuencr

[
    {
        "attributeName": "firstName",
        "operator": "=",
        "value": "John"
    },
    {
        "attributeName": "dateOfBirth",
        "operator": "<",
        "value": "1990-12-31"
    }
]

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "enrollmentId": "string",
        "status": "FINALIZED",
        "enrollmentType": "string",
        "enrollmentFlags": [
            {
                "timeout": 3600,
                "other": "other"
            }
        ],
        "requestData": [
            {
                "requestType": "IDCARD_ISSUANCE",
                "deliveryPlace": "paris",
                "other": "other"
            }
        ],
        "biographicData": {
            "dateOfBirth": "1985-11-30",
            "gender": "M",
            "nationality": "FRA"
        },
        "biometricData": [
            {
                "biometricType": "FACE",
                "biometricSubType": "UNKNOWN",
                "image": "c3RyaW5n",
                "imageRef": "https://example.com",
                "captureDate": "2020-07-01",
                "captureDevice": "string",
                "impressionType": "LIVE_SCAN_PLAIN",
                "width": 1,
                "height": 1,
                "bitdepth": 1,
                "mimetype": "string",
                "resolution": 1,
                "compression": "NONE"
            }
        ],
        "documentData": [
            {
                "documentType": "ID_CARD",
                "instance": "string",
                "parts": [
                    {
                        "pages": [
                            1
                        ],
                        "data": "c3RyaW5n",
                        "dataRef": "https://example.com",
                        "width": 1,
                        "height": 1,
                        "captureDate": "2020-07-01",
                        "captureDevice": "string",
                        "mimetype": "string"
                    }
                ]
            }
        ]
    }
]

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

7.3.4.1.2. Buffer¶

POST /v1/enrollments/{enrollmentId}/buffer¶

This service is used to send separately the buffers of the images

Scope required: enroll.buf.write

Query Parameters:
Parameters:	enrollmentId (string) – the id of the enrollment
	transactionId (string) – The id of the transaction (Required)
Status Codes:	201 Created – Operation successful 400 Bad Request – Bad request 403 Forbidden – Update not allowed 404 Not Found – Unknown record 500 Internal Server Error – Unexpected error

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
    "bufferId": "string"
}

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

GET /v1/enrollments/{enrollmentId}/buffer/{bufferId}¶

This service is used to get the buffer of the images

Scope required: enroll.buf.read

Query Parameters:
Parameters:	enrollmentId (string) – the id of the enrollment bufferId (string) – the id of the buffer
	transactionId (string) – The id of the transaction (Required)
Status Codes:	200 OK – Read successful 400 Bad Request – Bad request 403 Forbidden – Update not allowed 404 Not Found – Unknown record 500 Internal Server Error – Unexpected error

Example request:

GET /v1/enrollments/{enrollmentId}/buffer/{bufferId}?transactionId=string HTTP/1.1
Host: example.com
Authorization: Bearer cn389ncoiwuencr

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

7.3.4.2. Data Model¶

To be completed

7.3.4. Enrollment¶

7.3.4.1. Services¶

7.3.4.1.1. Enrollment¶

7.3.4.1.2. Buffer¶

7.3.4.2. Data Model¶

Navigation

Related Topics