Skip to content
DEVELOPER DOCUMENTATION
/
API Overview
/
/
Retrieve resources from a...

Namirial Onboarding API (2.0.0)

Namirial Onboarding API

Do you support non-breaking changes? A non-breaking change means that we are able to change some aspects of the API and it should not affect your integration. For instance, changes at API level listed below should not carry out any inconvenience to your integration:

  • Adding new response fields.
  • Adding new response headers.
  • Adding new endpoints / operations.
  • Adding new optional parameters in the requests.
  • Changing the order of properties in existing API responses.
  • Changing the length or format of strings and string based ids.
Download OpenAPI description
openapi-1.json
openapi-1.yaml
Languages
Servers
Mock server

https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/

https://test-eu-ie1-api.namirialonboarding.com/api/v2/

Request API

Set of APIs for creating new instances of requests and retrieving their details.

Operations

Create a new request

Request

Security
ApiKeyAuth
Query
idempotencyKeystring<= 64 characters

Optional field. If the endpoint already have received a request with the same IdempotencyKey in the last 7 days (+1 day: not strict, depending on operation scheduling) it replies with the same body that has been sent the first time. Please note, that entity in the body, may have been updated in the meantime and those changes will not be present in any next replies. The idempotency key should not be reused by the Integrator to refer to a different request, it is meant to be temporary, specific to reties of a single request to avoid duplications.

languagestring
draftboolean

if draft is true then the request is created in a draft status, so idempotencyKey is ignored and all the validations will be done when the request will be effectively created through the requestIdCreation endpoint. All the draft requests will be deleted after 7 days unless they are actually created

Bodyapplication/json
referenceIdstring(ReferenceId)

Optional field. It maps an id that is relevant for the Integrator. The filed is not used internally. More requests can have the same value.

Example: "order-1234-0002"
requestTypeIdstring(uuid)(RequestTypeId)required

Identifier of the type of process associated to the request. This identifier is given to the Integrator during initial setup of the integration project.

parametersobject(ObjectNode)
settingsobject(ObjectNode)
operatorPendingboolean
terminationReasonstring(TerminationReason)
  • "ERROR_OPERATOR_WRONG_FIRSTNAME"
  • "ERROR_OPERATOR_WRONG_SURNAME"
  • "ERROR_OPERATOR_INVERSION_FIRSTNAME_SURNAME"
  • "ERROR_OPERATOR_WRONG_BIRTH_DATE"
  • "ERROR_OPERATOR_WRONG_BIRTH_PLACE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUED_COUNTRY"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_EXPIRE_DATE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_AUTHORITY"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_AUTHORITY_TYPE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_NUMBER"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_DATE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_TYPE"
  • "ERROR_OPERATOR_WRONG_FISCAL_CODE"
  • "ERROR_OPERATOR_OTHER"
  • "ERROR_DH_IDENTITY_VERIFICATION_VALIDATION"
  • "ERROR_IDENTITY_OPERATOR_CANCELLED"
  • "ERROR_IDENTITY_FIELD_REQUEST_NOT_MATCHED"
  • "ERROR_IDENTITY_ID_SELF"
  • "ERROR_IDENTITY_ID_SELF_NULL_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CONTROLS_SUMMARY"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CHECK_RESPONSE_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_RESPONSE"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_CONTROLS_SUMMARY"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_RESPONSE_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_TYPE"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_NOT_ALLOWED"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_EXPIRED"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_SPECIMEN"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_NO_BACK_SIDE_FOUND"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_NO_FRONT_SIDE_FOUND"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CHECK_RESPONSE"
  • "ERROR_IDENTITY_ID_SELF_IDENTIFICATION_FAILED"
  • "ERROR_IDENTITY_ID_SELF_HOLDER_INFO_MISMATCH"
  • "ERROR_IDENTITY_ID_SELF_VIDEO_RECORDING_COULD_NOT_BE_ACHIEVED"
  • "ERROR_IDENTITY_ID_SELF_MISSING_PARAMETER"
  • "ERROR_IDENTITY_ID_SELF_INVALID_PARAMETER"
  • "ERROR_IDENTITY_ID_SELF_INVALID_URL"
  • "ERROR_IDENTITY_ID_SELF_BAD_QUALITY"
  • "ERROR_IDENTITY_ID_SELF_RECORDING_EXPIRED_OR_CANCELLED"
  • "ERROR_IDENTITY_ID_SELF_TOO_LARGE_CONTENT"
  • "ERROR_IDENTITY_ID_SELF_MRZ_BROKEN_INCOMPLETE_OR_NOT_FOUND"
  • "ERROR_IDENTITY_ID_SELF_BIOMETRY_FACE_DETECTION_ISSUES"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_AND_REQUESTED_TYPE_MISMATCH"
  • "ERROR_IDENTITY_ID_SELF_UNSUPPORTED_BANK"
  • "ERROR_IDENTITY_ID_SELF_LIVE_CHECK_CAN_NOT_BE_PERFORMED"
  • "ERROR_SIGN_INVALID_PHONE_NUMBER"
  • "ERROR_SIGN_INVALID_HOLDER_INFORMATION"
  • "ERROR_SIGN_MISSING_REQUEST_INFORMATION"
  • "CANCELLED_BY_USER"
  • "ERROR_IDENTITY_ID_SELF_STATUS_NOT_DONE"
customerAttributesobject(ObjectNode)
curl -i -X POST \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/requests?idempotencyKey=string&language=string&draft=true' \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "referenceId": "order-1234-0002",
    "requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
    "parameters": {
      "additionalProp0": "string",
      "property1": {},
      "property2": {}
    },
    "settings": {
      "additionalProp0": "string",
      "property1": {},
      "property2": {}
    },
    "operatorPending": true,
    "terminationReason": "string",
    "customerAttributes": {
      "additionalProp0": "string",
      "property1": {},
      "property2": {}
    }
  }'

Responses

The created request

Bodyapplication/json
idstring(uuid)read-only
organizationIdstring(uuid)read-only
statusstring(RequestStatus)read-only
  • DRAFT: The request has not been created yet, but it can be modified
  • CREATED: The request has been created, but its processing has to start yet.
  • RUNNING: The request is being processed, it means that actions from users or systems still have to be completed.
  • COMPLETED: Final status for a request completed successfully (according to specific request type it may have warnings or unsuccessful scenarios accepted by operational behavior).
  • EXPIRED: Final status for a request that has not been completed before the expiration time.
  • FAILED: Final status for a request whose processing has failed.
  • CANCELLED: Final status for a request that has been cancelled or completed unsuccessfully.
  • USER_CANCELLED: DEPRECATED - Final status for a request that a user has explicitly cancelled (not applicable to all request types).
  • OPERATOR_CANCELLED: DEPRECATED - Final status for a request that an operator has explicitly cancelled (not applicable to all request types).
  • DRAFT_EXPIRED: DEPRECATED - Final status for a request in draft status that has not been published before the expiration time
Enum"DRAFT""CREATED""RUNNING""COMPLETED""EXPIRED""FAILED""CANCELLED"
referenceIdstring(ReferenceId)

Optional field. It maps an id that is relevant for the Integrator. The filed is not used internally. More requests can have the same value.

Example: "order-1234-0002"
requestTypeIdstring(uuid)(RequestTypeId)required

Identifier of the type of process associated to the request. This identifier is given to the Integrator during initial setup of the integration project.

parametersobject(ObjectNode)
settingsobject(ObjectNode)
createdAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
updatedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
finalizedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
expireAfterobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
anonymizedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
operatorPendingboolean
terminationReasonstring(TerminationReason)
  • "ERROR_OPERATOR_WRONG_FIRSTNAME"
  • "ERROR_OPERATOR_WRONG_SURNAME"
  • "ERROR_OPERATOR_INVERSION_FIRSTNAME_SURNAME"
  • "ERROR_OPERATOR_WRONG_BIRTH_DATE"
  • "ERROR_OPERATOR_WRONG_BIRTH_PLACE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUED_COUNTRY"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_EXPIRE_DATE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_AUTHORITY"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_AUTHORITY_TYPE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_NUMBER"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_DATE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_TYPE"
  • "ERROR_OPERATOR_WRONG_FISCAL_CODE"
  • "ERROR_OPERATOR_OTHER"
  • "ERROR_DH_IDENTITY_VERIFICATION_VALIDATION"
  • "ERROR_IDENTITY_OPERATOR_CANCELLED"
  • "ERROR_IDENTITY_FIELD_REQUEST_NOT_MATCHED"
  • "ERROR_IDENTITY_ID_SELF"
  • "ERROR_IDENTITY_ID_SELF_NULL_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CONTROLS_SUMMARY"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CHECK_RESPONSE_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_RESPONSE"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_CONTROLS_SUMMARY"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_RESPONSE_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_TYPE"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_NOT_ALLOWED"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_EXPIRED"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_SPECIMEN"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_NO_BACK_SIDE_FOUND"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_NO_FRONT_SIDE_FOUND"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CHECK_RESPONSE"
  • "ERROR_IDENTITY_ID_SELF_IDENTIFICATION_FAILED"
  • "ERROR_IDENTITY_ID_SELF_HOLDER_INFO_MISMATCH"
  • "ERROR_IDENTITY_ID_SELF_VIDEO_RECORDING_COULD_NOT_BE_ACHIEVED"
  • "ERROR_IDENTITY_ID_SELF_MISSING_PARAMETER"
  • "ERROR_IDENTITY_ID_SELF_INVALID_PARAMETER"
  • "ERROR_IDENTITY_ID_SELF_INVALID_URL"
  • "ERROR_IDENTITY_ID_SELF_BAD_QUALITY"
  • "ERROR_IDENTITY_ID_SELF_RECORDING_EXPIRED_OR_CANCELLED"
  • "ERROR_IDENTITY_ID_SELF_TOO_LARGE_CONTENT"
  • "ERROR_IDENTITY_ID_SELF_MRZ_BROKEN_INCOMPLETE_OR_NOT_FOUND"
  • "ERROR_IDENTITY_ID_SELF_BIOMETRY_FACE_DETECTION_ISSUES"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_AND_REQUESTED_TYPE_MISMATCH"
  • "ERROR_IDENTITY_ID_SELF_UNSUPPORTED_BANK"
  • "ERROR_IDENTITY_ID_SELF_LIVE_CHECK_CAN_NOT_BE_PERFORMED"
  • "ERROR_SIGN_INVALID_PHONE_NUMBER"
  • "ERROR_SIGN_INVALID_HOLDER_INFORMATION"
  • "ERROR_SIGN_MISSING_REQUEST_INFORMATION"
  • "CANCELLED_BY_USER"
  • "ERROR_IDENTITY_ID_SELF_STATUS_NOT_DONE"
customerAttributesobject(ObjectNode)
linksArray of objects(RequestLink)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "status": "DRAFT",
  "referenceId": "order-1234-0002",
  "requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
  "parameters": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  },
  "settings": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  },
  "createdAt": "2024-10-22T12:19:12.269594Z",
  "updatedAt": "2024-10-22T12:19:12.269594Z",
  "finalizedAt": "2024-10-22T12:19:12.269594Z",
  "expireAfter": "2024-10-22T12:19:12.269594Z",
  "anonymizedAt": "2024-10-22T12:19:12.269594Z",
  "operatorPending": true,
  "terminationReason": "string",
  "customerAttributes": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  },
  "links": [
    { … }
  ]
}

Get requests

Request

Sorting Fields:

  • createdAt
  • updatedAt

Note: Due to caching mechanism the bulk view may not be in sync with single request detail view.

Security
ApiKeyAuth
Query
sortstring

Not all fields are supported in sorting. See the description of the endpoint for the list of supported fields. Specify the field to sort and the ordering (asc, or desc) separated by a coma.

Example: sort=createdAt,desc
pageinteger(int64)

Page numbers starting at 0.

sizeinteger(int64)

Size 0 equals to default size. Maximum size may be limited anytime and not honored by the backend.

statusstring

Used to filter requests by their current status.

Example: status=RUNNING
referenceIdstring

Used to filter requests by their referenceId.

Example: referenceId=order-1234-0002
operatorPendingboolean

Used to filter requests by operatorPending.

idstring(uuid)

Used to filter requests by id.

requestTypeIdstring(uuid)

Used to filter requests by requestTypeId.

organizationIdstring(uuid)

Used to filter requests by organizationId.

searchstring

Used to search for requests by identified people's first name, last name and / or personal number.

curl -i -X GET \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/requests?sort=createdAt%2Cdesc&page=0&size=0&status=RUNNING&referenceId=order-1234-0002&operatorPending=true&id=497f6eca-6276-4993-bfeb-53cbbbba6f08&requestTypeId=497f6eca-6276-4993-bfeb-53cbbbba6f08&organizationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&search=string' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

The fetched request

Bodyapplication/json
contentArray of objects(RequestsGet)
pageobject(Page)
Response
application/json
{
  "content": [
    { … }
  ],
  "page": {
    "size": 1,
    "number": 0,
    "totalElements": 4,
    "totalPages": 4
  }
}

Generate Requests Export

Request

Security
ApiKeyAuth
Bodyapplication/json
organizationIdstring(uuid)
createdAtStartobject(InstantDateTime)
Example: "2024-10-22T12:19:12.269594Z"
createdAtEndobject(InstantDateTime)
Example: "2024-10-22T12:19:12.269594Z"
requestTypeIdstring(uuid)
curl -i -X POST \
  https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/requests/export \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
    "createdAtStart": "2024-10-22T12:19:12.269594Z",
    "createdAtEnd": "2024-10-22T12:19:12.269594Z",
    "requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329"
  }'

Responses

Ok,

Bodyapplication/json
any
Response
application/json
null

Get request

Request

Security
ApiKeyAuth
Path
idstring(uuid)required
curl -i -X GET \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/request/{id}' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

The request

Bodyapplication/json
idstring(uuid)read-only
organizationIdstring(uuid)read-only
statusstring(RequestStatus)read-only
  • DRAFT: The request has not been created yet, but it can be modified
  • CREATED: The request has been created, but its processing has to start yet.
  • RUNNING: The request is being processed, it means that actions from users or systems still have to be completed.
  • COMPLETED: Final status for a request completed successfully (according to specific request type it may have warnings or unsuccessful scenarios accepted by operational behavior).
  • EXPIRED: Final status for a request that has not been completed before the expiration time.
  • FAILED: Final status for a request whose processing has failed.
  • CANCELLED: Final status for a request that has been cancelled or completed unsuccessfully.
  • USER_CANCELLED: DEPRECATED - Final status for a request that a user has explicitly cancelled (not applicable to all request types).
  • OPERATOR_CANCELLED: DEPRECATED - Final status for a request that an operator has explicitly cancelled (not applicable to all request types).
  • DRAFT_EXPIRED: DEPRECATED - Final status for a request in draft status that has not been published before the expiration time
Enum"DRAFT""CREATED""RUNNING""COMPLETED""EXPIRED""FAILED""CANCELLED"
referenceIdstring(ReferenceId)

Optional field. It maps an id that is relevant for the Integrator. The filed is not used internally. More requests can have the same value.

Example: "order-1234-0002"
requestTypeIdstring(uuid)(RequestTypeId)required

Identifier of the type of process associated to the request. This identifier is given to the Integrator during initial setup of the integration project.

parametersobject(ObjectNode)
settingsobject(ObjectNode)
createdAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
updatedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
finalizedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
expireAfterobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
anonymizedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
operatorPendingboolean
terminationReasonstring(TerminationReason)
  • "ERROR_OPERATOR_WRONG_FIRSTNAME"
  • "ERROR_OPERATOR_WRONG_SURNAME"
  • "ERROR_OPERATOR_INVERSION_FIRSTNAME_SURNAME"
  • "ERROR_OPERATOR_WRONG_BIRTH_DATE"
  • "ERROR_OPERATOR_WRONG_BIRTH_PLACE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUED_COUNTRY"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_EXPIRE_DATE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_AUTHORITY"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_AUTHORITY_TYPE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_NUMBER"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_DATE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_TYPE"
  • "ERROR_OPERATOR_WRONG_FISCAL_CODE"
  • "ERROR_OPERATOR_OTHER"
  • "ERROR_DH_IDENTITY_VERIFICATION_VALIDATION"
  • "ERROR_IDENTITY_OPERATOR_CANCELLED"
  • "ERROR_IDENTITY_FIELD_REQUEST_NOT_MATCHED"
  • "ERROR_IDENTITY_ID_SELF"
  • "ERROR_IDENTITY_ID_SELF_NULL_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CONTROLS_SUMMARY"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CHECK_RESPONSE_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_RESPONSE"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_CONTROLS_SUMMARY"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_RESPONSE_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_TYPE"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_NOT_ALLOWED"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_EXPIRED"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_SPECIMEN"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_NO_BACK_SIDE_FOUND"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_NO_FRONT_SIDE_FOUND"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CHECK_RESPONSE"
  • "ERROR_IDENTITY_ID_SELF_IDENTIFICATION_FAILED"
  • "ERROR_IDENTITY_ID_SELF_HOLDER_INFO_MISMATCH"
  • "ERROR_IDENTITY_ID_SELF_VIDEO_RECORDING_COULD_NOT_BE_ACHIEVED"
  • "ERROR_IDENTITY_ID_SELF_MISSING_PARAMETER"
  • "ERROR_IDENTITY_ID_SELF_INVALID_PARAMETER"
  • "ERROR_IDENTITY_ID_SELF_INVALID_URL"
  • "ERROR_IDENTITY_ID_SELF_BAD_QUALITY"
  • "ERROR_IDENTITY_ID_SELF_RECORDING_EXPIRED_OR_CANCELLED"
  • "ERROR_IDENTITY_ID_SELF_TOO_LARGE_CONTENT"
  • "ERROR_IDENTITY_ID_SELF_MRZ_BROKEN_INCOMPLETE_OR_NOT_FOUND"
  • "ERROR_IDENTITY_ID_SELF_BIOMETRY_FACE_DETECTION_ISSUES"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_AND_REQUESTED_TYPE_MISMATCH"
  • "ERROR_IDENTITY_ID_SELF_UNSUPPORTED_BANK"
  • "ERROR_IDENTITY_ID_SELF_LIVE_CHECK_CAN_NOT_BE_PERFORMED"
  • "ERROR_SIGN_INVALID_PHONE_NUMBER"
  • "ERROR_SIGN_INVALID_HOLDER_INFORMATION"
  • "ERROR_SIGN_MISSING_REQUEST_INFORMATION"
  • "CANCELLED_BY_USER"
  • "ERROR_IDENTITY_ID_SELF_STATUS_NOT_DONE"
customerAttributesobject(ObjectNode)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "status": "DRAFT",
  "referenceId": "order-1234-0002",
  "requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
  "parameters": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  },
  "settings": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  },
  "createdAt": "2024-10-22T12:19:12.269594Z",
  "updatedAt": "2024-10-22T12:19:12.269594Z",
  "finalizedAt": "2024-10-22T12:19:12.269594Z",
  "expireAfter": "2024-10-22T12:19:12.269594Z",
  "anonymizedAt": "2024-10-22T12:19:12.269594Z",
  "operatorPending": true,
  "terminationReason": "string",
  "customerAttributes": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  }
}

Modify a request in status DRAFT

Request

Security
bearerAuth
Path
idstring(uuid)required
Query
createboolean
Bodyapplication/json
referenceIdstring(ReferenceId)

Optional field. It maps an id that is relevant for the Integrator. The filed is not used internally. More requests can have the same value.

Example: "order-1234-0002"
parametersobject(ObjectNode)
settingsobject(ObjectNode)
customerAttributesobject(ObjectNode)
curl -i -X PUT \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/request/{id}?create=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "referenceId": "order-1234-0002",
    "parameters": {
      "additionalProp0": "string",
      "property1": {},
      "property2": {}
    },
    "settings": {
      "additionalProp0": "string",
      "property1": {},
      "property2": {}
    },
    "customerAttributes": {
      "additionalProp0": "string",
      "property1": {},
      "property2": {}
    }
  }'

Responses

The created request

Bodyapplication/json
idstring(uuid)read-only
organizationIdstring(uuid)read-only
statusstring(RequestStatus)read-only
  • DRAFT: The request has not been created yet, but it can be modified
  • CREATED: The request has been created, but its processing has to start yet.
  • RUNNING: The request is being processed, it means that actions from users or systems still have to be completed.
  • COMPLETED: Final status for a request completed successfully (according to specific request type it may have warnings or unsuccessful scenarios accepted by operational behavior).
  • EXPIRED: Final status for a request that has not been completed before the expiration time.
  • FAILED: Final status for a request whose processing has failed.
  • CANCELLED: Final status for a request that has been cancelled or completed unsuccessfully.
  • USER_CANCELLED: DEPRECATED - Final status for a request that a user has explicitly cancelled (not applicable to all request types).
  • OPERATOR_CANCELLED: DEPRECATED - Final status for a request that an operator has explicitly cancelled (not applicable to all request types).
  • DRAFT_EXPIRED: DEPRECATED - Final status for a request in draft status that has not been published before the expiration time
Enum"DRAFT""CREATED""RUNNING""COMPLETED""EXPIRED""FAILED""CANCELLED"
referenceIdstring(ReferenceId)

Optional field. It maps an id that is relevant for the Integrator. The filed is not used internally. More requests can have the same value.

Example: "order-1234-0002"
requestTypeIdstring(uuid)(RequestTypeId)required

Identifier of the type of process associated to the request. This identifier is given to the Integrator during initial setup of the integration project.

parametersobject(ObjectNode)
settingsobject(ObjectNode)
createdAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
updatedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
finalizedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
expireAfterobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
anonymizedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
operatorPendingboolean
terminationReasonstring(TerminationReason)
  • "ERROR_OPERATOR_WRONG_FIRSTNAME"
  • "ERROR_OPERATOR_WRONG_SURNAME"
  • "ERROR_OPERATOR_INVERSION_FIRSTNAME_SURNAME"
  • "ERROR_OPERATOR_WRONG_BIRTH_DATE"
  • "ERROR_OPERATOR_WRONG_BIRTH_PLACE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUED_COUNTRY"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_EXPIRE_DATE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_AUTHORITY"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_AUTHORITY_TYPE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_NUMBER"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_DATE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_TYPE"
  • "ERROR_OPERATOR_WRONG_FISCAL_CODE"
  • "ERROR_OPERATOR_OTHER"
  • "ERROR_DH_IDENTITY_VERIFICATION_VALIDATION"
  • "ERROR_IDENTITY_OPERATOR_CANCELLED"
  • "ERROR_IDENTITY_FIELD_REQUEST_NOT_MATCHED"
  • "ERROR_IDENTITY_ID_SELF"
  • "ERROR_IDENTITY_ID_SELF_NULL_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CONTROLS_SUMMARY"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CHECK_RESPONSE_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_RESPONSE"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_CONTROLS_SUMMARY"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_RESPONSE_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_TYPE"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_NOT_ALLOWED"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_EXPIRED"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_SPECIMEN"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_NO_BACK_SIDE_FOUND"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_NO_FRONT_SIDE_FOUND"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CHECK_RESPONSE"
  • "ERROR_IDENTITY_ID_SELF_IDENTIFICATION_FAILED"
  • "ERROR_IDENTITY_ID_SELF_HOLDER_INFO_MISMATCH"
  • "ERROR_IDENTITY_ID_SELF_VIDEO_RECORDING_COULD_NOT_BE_ACHIEVED"
  • "ERROR_IDENTITY_ID_SELF_MISSING_PARAMETER"
  • "ERROR_IDENTITY_ID_SELF_INVALID_PARAMETER"
  • "ERROR_IDENTITY_ID_SELF_INVALID_URL"
  • "ERROR_IDENTITY_ID_SELF_BAD_QUALITY"
  • "ERROR_IDENTITY_ID_SELF_RECORDING_EXPIRED_OR_CANCELLED"
  • "ERROR_IDENTITY_ID_SELF_TOO_LARGE_CONTENT"
  • "ERROR_IDENTITY_ID_SELF_MRZ_BROKEN_INCOMPLETE_OR_NOT_FOUND"
  • "ERROR_IDENTITY_ID_SELF_BIOMETRY_FACE_DETECTION_ISSUES"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_AND_REQUESTED_TYPE_MISMATCH"
  • "ERROR_IDENTITY_ID_SELF_UNSUPPORTED_BANK"
  • "ERROR_IDENTITY_ID_SELF_LIVE_CHECK_CAN_NOT_BE_PERFORMED"
  • "ERROR_SIGN_INVALID_PHONE_NUMBER"
  • "ERROR_SIGN_INVALID_HOLDER_INFORMATION"
  • "ERROR_SIGN_MISSING_REQUEST_INFORMATION"
  • "CANCELLED_BY_USER"
  • "ERROR_IDENTITY_ID_SELF_STATUS_NOT_DONE"
customerAttributesobject(ObjectNode)
linksArray of objects(RequestLink)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "status": "DRAFT",
  "referenceId": "order-1234-0002",
  "requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
  "parameters": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  },
  "settings": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  },
  "createdAt": "2024-10-22T12:19:12.269594Z",
  "updatedAt": "2024-10-22T12:19:12.269594Z",
  "finalizedAt": "2024-10-22T12:19:12.269594Z",
  "expireAfter": "2024-10-22T12:19:12.269594Z",
  "anonymizedAt": "2024-10-22T12:19:12.269594Z",
  "operatorPending": true,
  "terminationReason": "string",
  "customerAttributes": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  },
  "links": [
    { … }
  ]
}

Publish a request in status DRAFT

Request

Security
bearerAuth
Path
idstring(uuid)required
Bodyapplication/json
object
curl -i -X POST \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/request/{id}/creation' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The created request

Bodyapplication/json
idstring(uuid)read-only
organizationIdstring(uuid)read-only
statusstring(RequestStatus)read-only
  • DRAFT: The request has not been created yet, but it can be modified
  • CREATED: The request has been created, but its processing has to start yet.
  • RUNNING: The request is being processed, it means that actions from users or systems still have to be completed.
  • COMPLETED: Final status for a request completed successfully (according to specific request type it may have warnings or unsuccessful scenarios accepted by operational behavior).
  • EXPIRED: Final status for a request that has not been completed before the expiration time.
  • FAILED: Final status for a request whose processing has failed.
  • CANCELLED: Final status for a request that has been cancelled or completed unsuccessfully.
  • USER_CANCELLED: DEPRECATED - Final status for a request that a user has explicitly cancelled (not applicable to all request types).
  • OPERATOR_CANCELLED: DEPRECATED - Final status for a request that an operator has explicitly cancelled (not applicable to all request types).
  • DRAFT_EXPIRED: DEPRECATED - Final status for a request in draft status that has not been published before the expiration time
Enum"DRAFT""CREATED""RUNNING""COMPLETED""EXPIRED""FAILED""CANCELLED"
referenceIdstring(ReferenceId)

Optional field. It maps an id that is relevant for the Integrator. The filed is not used internally. More requests can have the same value.

Example: "order-1234-0002"
requestTypeIdstring(uuid)(RequestTypeId)required

Identifier of the type of process associated to the request. This identifier is given to the Integrator during initial setup of the integration project.

parametersobject(ObjectNode)
settingsobject(ObjectNode)
createdAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
updatedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
finalizedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
expireAfterobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
anonymizedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
operatorPendingboolean
terminationReasonstring(TerminationReason)
  • "ERROR_OPERATOR_WRONG_FIRSTNAME"
  • "ERROR_OPERATOR_WRONG_SURNAME"
  • "ERROR_OPERATOR_INVERSION_FIRSTNAME_SURNAME"
  • "ERROR_OPERATOR_WRONG_BIRTH_DATE"
  • "ERROR_OPERATOR_WRONG_BIRTH_PLACE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUED_COUNTRY"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_EXPIRE_DATE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_AUTHORITY"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_AUTHORITY_TYPE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_NUMBER"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_DATE"
  • "ERROR_OPERATOR_WRONG_DOCUMENT_TYPE"
  • "ERROR_OPERATOR_WRONG_FISCAL_CODE"
  • "ERROR_OPERATOR_OTHER"
  • "ERROR_DH_IDENTITY_VERIFICATION_VALIDATION"
  • "ERROR_IDENTITY_OPERATOR_CANCELLED"
  • "ERROR_IDENTITY_FIELD_REQUEST_NOT_MATCHED"
  • "ERROR_IDENTITY_ID_SELF"
  • "ERROR_IDENTITY_ID_SELF_NULL_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CONTROLS_SUMMARY"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CHECK_RESPONSE_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_RESPONSE"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_CONTROLS_SUMMARY"
  • "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_RESPONSE_REQUEST_INFO"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_TYPE"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_NOT_ALLOWED"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_EXPIRED"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_SPECIMEN"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_NO_BACK_SIDE_FOUND"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_NO_FRONT_SIDE_FOUND"
  • "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CHECK_RESPONSE"
  • "ERROR_IDENTITY_ID_SELF_IDENTIFICATION_FAILED"
  • "ERROR_IDENTITY_ID_SELF_HOLDER_INFO_MISMATCH"
  • "ERROR_IDENTITY_ID_SELF_VIDEO_RECORDING_COULD_NOT_BE_ACHIEVED"
  • "ERROR_IDENTITY_ID_SELF_MISSING_PARAMETER"
  • "ERROR_IDENTITY_ID_SELF_INVALID_PARAMETER"
  • "ERROR_IDENTITY_ID_SELF_INVALID_URL"
  • "ERROR_IDENTITY_ID_SELF_BAD_QUALITY"
  • "ERROR_IDENTITY_ID_SELF_RECORDING_EXPIRED_OR_CANCELLED"
  • "ERROR_IDENTITY_ID_SELF_TOO_LARGE_CONTENT"
  • "ERROR_IDENTITY_ID_SELF_MRZ_BROKEN_INCOMPLETE_OR_NOT_FOUND"
  • "ERROR_IDENTITY_ID_SELF_BIOMETRY_FACE_DETECTION_ISSUES"
  • "ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_AND_REQUESTED_TYPE_MISMATCH"
  • "ERROR_IDENTITY_ID_SELF_UNSUPPORTED_BANK"
  • "ERROR_IDENTITY_ID_SELF_LIVE_CHECK_CAN_NOT_BE_PERFORMED"
  • "ERROR_SIGN_INVALID_PHONE_NUMBER"
  • "ERROR_SIGN_INVALID_HOLDER_INFORMATION"
  • "ERROR_SIGN_MISSING_REQUEST_INFORMATION"
  • "CANCELLED_BY_USER"
  • "ERROR_IDENTITY_ID_SELF_STATUS_NOT_DONE"
customerAttributesobject(ObjectNode)
linksArray of objects(RequestLink)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "status": "DRAFT",
  "referenceId": "order-1234-0002",
  "requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
  "parameters": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  },
  "settings": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  },
  "createdAt": "2024-10-22T12:19:12.269594Z",
  "updatedAt": "2024-10-22T12:19:12.269594Z",
  "finalizedAt": "2024-10-22T12:19:12.269594Z",
  "expireAfter": "2024-10-22T12:19:12.269594Z",
  "anonymizedAt": "2024-10-22T12:19:12.269594Z",
  "operatorPending": true,
  "terminationReason": "string",
  "customerAttributes": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  },
  "links": [
    { … }
  ]
}

Generate new links associated to a request. Previous links (if not expired) are still usable.

Request

Security
ApiKeyAuth
Path
idstring(uuid)required
Bodyapplication/json
onlyForActorsArray of strings(ActorId)

If not empty, it limits the generation only for the listed actors. Otherwise, it generates for all actors.

Example: ["customer"]
curl -i -X POST \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/request/{id}/links' \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "onlyForActors": [
      "customer"
    ]
  }'

Responses

The created request

Bodyapplication/json
linksArray of objects(RequestLink)
Response
application/json
{
  "links": [
    { … }
  ]
}

Retrieves resources from a request as a ZIP archive

Request

Security
bearerAuth
Path
idstring(uuid)required
Bodyapplication/json
urlValidBeforeobject(InstantDateTime)
Example: "2024-10-22T12:19:12.269594Z"
dispositionstring(DownloadContentDisposition)

Values may be added overtime. List of values:

  • "INLINE"
  • "ATTACHMENT"
Example: "INLINE"
includeUnavailableboolean
orFiltersArray of objects(ResourceLinkRequestFilter)
curl -i -X POST \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/request/{id}/resources/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "urlValidBefore": "2024-10-22T12:19:12.269594Z",
    "disposition": "INLINE",
    "includeUnavailable": true,
    "orFilters": [
      {
        "type": "BIOMETRY_VIDEO",
        "subtype": "FRONT_SIDE",
        "family": "IDENTIFICATION_ASSET",
        "linkedToIdentificationId": "e40c45ac-2c57-4939-8389-6699f7353c82"
      }
    ]
  }'

Responses

ZIP archive

Bodyapplication/zip
dummystring

Retrieve resources from a request

Request

Security
ApiKeyAuth
Path
idstring(uuid)required
Bodyapplication/json
downloadArchiveboolean
urlValidBeforeobject(InstantDateTime)
Example: "2024-10-22T12:19:12.269594Z"
dispositionstring(DownloadContentDisposition)

Values may be added overtime. List of values:

  • "INLINE"
  • "ATTACHMENT"
Example: "INLINE"
includeUnavailableboolean
orFiltersArray of objects(ResourceLinkRequestFilter)
curl -i -X POST \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/request/{id}/resources/links' \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "downloadArchive": true,
    "urlValidBefore": "2024-10-22T12:19:12.269594Z",
    "disposition": "INLINE",
    "includeUnavailable": true,
    "orFilters": [
      {
        "type": "BIOMETRY_VIDEO",
        "subtype": "FRONT_SIDE",
        "family": "IDENTIFICATION_ASSET",
        "linkedToIdentificationId": "e40c45ac-2c57-4939-8389-6699f7353c82"
      }
    ]
  }'

Responses

In case of payload, or in case of inline and zip it will be the octet-stream

Bodyapplication/jsonArray [
idstring(uuid)
filenamestring
Example: "audit_log.pdf"
mimeTypestring
namestring
Example: "Audit Log"
typestring(ResourceType)

Values may be added overtime. List of values:

  • 'BIOMETRY_VIDEO'
  • 'BIOMETRY_IMAGE'
  • 'DOCUMENT_VIDEO'
  • 'DOCUMENT_IMAGE'
  • 'CONTRACT_DOCUMENT'
  • 'DOCUMENT'
  • 'IDENTITY_DOCUMENT'
  • 'SIGN_AUDIT_LOG'
  • 'IDP_ASSERTION'
  • 'AUDIT_TRAIL'
Example: "BIOMETRY_VIDEO"
familystring(ResourceFamily)

Values may be added overtime. List of values:

  • 'IDENTIFICATION_ASSET'
  • 'SIGNED_DOCUMENT'
  • 'ATTACHMENT'
  • 'PROOF'
  • 'DOCUMENT_TO_SIGN'
Example: "IDENTIFICATION_ASSET"
subTypestring(ResourceSubType)

Values may be added overtime. List of values:

  • 'BEST_SELFIE'
  • 'PROCESSED_FRONT_SIDE'
  • 'PROCESSED_BACK_SIDE'
  • 'SELFIE'
  • 'FRONT_SIDE'
  • 'BACK_SIDE'
  • 'ID_PHOTO'
  • 'PROOF_RAW'
  • 'PROOF_RENDERED'
  • 'DOCUMENT_FILLED'
  • 'DOCUMENT_FLATTENED'
  • 'APPLICATION_FORM'
Example: "FRONT_SIDE"
metadataobject(ObjectNode)
resourceUrlstring(uri)
Example: "https://storage.onboarding.example/res/121323?ts=12386ddd"
urlValidBeforeobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
statusstring

Values may be added overtime. List of values:

  • AVAILABLE -> Can be downloaded
  • IN_TRANSFER -> The resource is still incomplete
  • ABORTED -> The resource was not completed
  • DELETED -> The resource was deleted
Example: "AVAILABLE"
resourceVersionIdstring
sizeBytesinteger(int64)
checksumstring
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "filename": "audit_log.pdf",
    "mimeType": "string",
    "name": "Audit Log",
    "type": "BIOMETRY_VIDEO",
    "family": "IDENTIFICATION_ASSET",
    "subType": "FRONT_SIDE",
    "metadata": { … },
    "resourceUrl": "https://storage.onboarding.example/res/121323?ts=12386ddd",
    "urlValidBefore": "2024-10-22T12:19:12.269594Z",
    "status": "AVAILABLE",
    "resourceVersionId": "string",
    "sizeBytes": 0,
    "checksum": "string"
  }
]

Get request Identifications

Request

Security
ApiKeyAuth
Path
idstring(uuid)required
curl -i -X GET \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/request/{id}/identifications' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

The request identifications

Bodyapplication/json
requestIdstring(uuid)
identificationsArray of objects(IdentificationSummary)
Response
application/json
{
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "identifications": [
    { … }
  ]
}

Get request identification detail.

Request

Security
ApiKeyAuth
Path
idstring(uuid)required
Query
identificationIdstring(uuid)

If not set, the endpoint returns the last identification.

actorstring

The id of the actor. According to the endpoint it may be required if multiple actors are defined for the requestType.

curl -i -X GET \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/request/{id}/identification?identificationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&actor=string' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

The request identifications

Bodyapplication/json
organizationIdstring(uuid)
personDataobject(PersonIdentification)
validationDetailobject(IdentificationValidationDetail)
operatorobject(OperatorCheckIdentification)
idSelfobject(FacematchIdentification)
spidobject(SpidIdentification)
cieobject(CieIdentification)
germanIdobject(GermanIdentification)
swissIdobject(SwissIdentification)
austriaIdobject(AustrianIdentification)
itWalletobject(ItWallet)
facephiobject(FacephiIdentification)
verifeyeobject(VerifeyeIdentification)
nfcobject(NfcIdentification)
idstring(uuid)
actorstring(ActorId)
Example: "customer"
stepIdstring
statusstring

The status of the identification. Values may be added overtime. Values:

  • PENDING
  • WAITING_FOR_APPROVAL
  • COMPLETED
  • REJECTED
  • FAILED
Example: "COMPLETED"
sourcestring

The source of identification for the actor. It may affect the presence of fields and details that are present in this Identification entity. Values may be added overtime. Values:

  • 'SPID'
  • 'ID-SELF'
Example: "ID-SELF"
finalizedAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
Response
application/json
{
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "personData": {
    "lastName": "Doe",
    "firstName": "John",
    "birthDate": "2019-08-24",
    "birthPlace": "FIRENZE",
    "personalNumber": "DNTCRL65S67M126L",
    "gender": "M",
    "nationality": "IT",
    "phoneNumber": "+393331112233",
    "address": { … },
    "email": "jjdoe@example.com",
    "documentDetails": { … }
  },
  "validationDetail": {
    "personalNumber": { … },
    "lastName": { … },
    "firstName": { … },
    "birthDate": { … },
    "gender": { … },
    "phoneNumber": { … },
    "email": { … },
    "documentNumber": { … }
  },
  "operator": {
    "idSelf": { … },
    "idSelfStartedAt": "2024-10-22T12:19:12.269594Z",
    "internalOperator": { … }
  },
  "idSelf": {
    "id": "string",
    "receivedAt": "2024-10-22T12:19:12.269594Z",
    "artifacts": { … },
    "biometryCheck": { … },
    "documentCheck": { … }
  },
  "spid": {
    "samlAssertion": { … },
    "spidCode": 123913921923,
    "fiscalNumber": "INIT-DNTCRL65S67M126L",
    "name": "string",
    "familyName": "string",
    "placeOfBirth": "string",
    "dateOfBirth": "2019-08-24",
    "gender": "M",
    "expirationDate": "2019-08-24",
    "countryOfBirth": "NA",
    "email": "string",
    "mobilePhone": "string",
    "address": "Via dei viali 8 00188 Napoli NA",
    "digitalAddress": "string",
    "idCard": "cartaIdentita ca972111al comuneNapoli 2007-11-19 2018-06-28",
    "companyName": "string",
    "registeredOffice": "string",
    "ivaCode": "string"
  },
  "cie": {
    "firstName": "string",
    "lastName": "string",
    "birthDate": "2019-08-24",
    "fiscalNumber": "string",
    "idpAssertion": { … }
  },
  "germanId": {
    "eidDocumentNumber": "string",
    "birthDate": "2019-08-24",
    "lastName": "string",
    "firstName": "string",
    "issuingCountry": "string",
    "documentType": "string",
    "birthPlace": "string",
    "idpAssertion": { … }
  },
  "swissId": {
    "lastName": "string",
    "phoneNumber": "string",
    "firstName": "string",
    "email": "string",
    "idpAssertion": { … }
  },
  "austriaId": {
    "lastName": "string",
    "firstName": "string",
    "email": "string",
    "phoneNumber": "string",
    "idpAssertion": { … }
  },
  "itWallet": {
    "familyName": "string",
    "givenName": "string",
    "birthDate": "2019-08-24",
    "taxIdCode": "string",
    "idpAssertion": { … }
  },
  "facephi": {
    "firstName": "string",
    "lastName": "string",
    "birthDate": "1970-01-01T00:00:00.000Z",
    "personalNumber": "string",
    "gender": "M",
    "documentNumber": "string",
    "documentType": "string",
    "issuedOn": "1970-01-01T00:00:00.000Z",
    "expiryDate": "1970-01-01T00:00:00.000Z",
    "placeOfIssue": "string",
    "issuingCountry": "string",
    "birthPlace": "string",
    "address": "string",
    "artifacts": { … }
  },
  "verifeye": {
    "firstName": "string",
    "lastName": "string",
    "birthDate": "1970-01-01T00:00:00.000Z",
    "gender": "M",
    "documentNumber": "string",
    "documentType": "NATIONAL_IDENTITY_CARD",
    "issuedOn": "1970-01-01T00:00:00.000Z",
    "expiryDate": "1970-01-01T00:00:00.000Z",
    "issuedBy": "string",
    "issuingCountry": "string",
    "birthPlace": "string",
    "address": "string",
    "phoneNumber": "string",
    "artifacts": { … }
  },
  "nfc": {
    "biometryCheck": { … },
    "documentCheck": { … },
    "documentIdentification": { … },
    "nfc": { … },
    "evidence": { … }
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "actor": "customer",
  "stepId": "string",
  "status": "COMPLETED",
  "source": "ID-SELF",
  "finalizedAt": "2024-10-22T12:19:12.269594Z"
}

Upload resource to a draft request

Request

Security
ApiKeyAuth
Path
idstring(uuid)required
Bodymultipart/form-data
filestring(binary)
resourceDescriptionobject(AddRequestResource)
curl -i -X POST \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/request/{id}/upload' \
  -H 'Content-Type: multipart/form-data' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -F file=string \
  -F 'resourceDescription[filename]=string' \
  -F 'resourceDescription[mimeType]=string' \
  -F 'resourceDescription[name]=string' \
  -F 'resourceDescription[type]=BIOMETRY_VIDEO' \
  -F 'resourceDescription[subType]=FRONT_SIDE' \
  -F 'resourceDescription[family]=IDENTIFICATION_ASSET' \
  -F 'resourceDescription[urlValidBefore]=2024-10-22T12:19:12.269594Z' \
  -F 'resourceDescription[metadata][additionalProp0]=string' \
  -F 'resourceDescription[sha256]=string'

Responses

The resource uri, version and etag

Bodyapplication/json
etagstring
versionstring
resourceUristring(uri)
Response
application/json
{
  "etag": "string",
  "version": "string",
  "resourceUri": "http://example.com"
}

Retrieves the CA22D module PDFs for the given requestId and actorId

Request

Security
ApiKeyAuth
Path
idstring(uuid)required
actorstringrequired
curl -i -X GET \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/request/{id}/actor/{actor}/ca22d' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

ZIP containing the requested signed CA22D module PDFs

Bodyapplication/zip
dummystring
Response
No content

Request Type API

Set of APIs for getting info about request types

Operations

Data Enrichment API

Set of APIs for Data Enrichment

Operations

DataHub API

Set of APIs for managing self-contained DataHub workflows that enable identity verification through advanced data intelligence. These APIs allow clients to initiate, monitor, and retrieve results from processes involving data analysis, validation, and matching against trusted sources as part of digital onboarding and compliance procedures.

Operations

Signature API

Operations