Skip to content
DEVELOPER DOCUMENTATION
/
/
/
Create a new request

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.

Webhooks

NOB delivers webhooks as POST requests with Content-Type: application/json to the URL configured on the integrator's WebhookConfiguration. Delivery is retried with backoff on failure.

Subscription topics vs. event type

Integrators subscribe to one or more topics. Each topic governs which type values a given webhook endpoint may receive:

TopicDelivers type values
REQUEST_STATUSSTATUS_UPDATE, STATUS_UPDATE_ACTOR, STATUS_UPDATE_STEP
REQUEST_LIFECYCLESTATUS_UPDATE (on draft/create transitions), REQUEST_FINALIZED
IDENTIFICATION_UPDATEIDENTIFICATION_OPERATOR_CHECK_UPDATE, IDENTIFICATION_DOCUMENTS_UPDATE, IDENTIFICATION_BIOMETRY_UPDATE
REQUEST_AUTHENTICATIONREQUEST_AUTHENTICATION
AUTOMATIC_RETRYAUTOMATIC_RETRY_TRIGGERED (opt-in)

When IDENTIFICATION_* events fire

IDENTIFICATION_OPERATOR_CHECK_UPDATE, IDENTIFICATION_DOCUMENTS_UPDATE and IDENTIFICATION_BIOMETRY_UPDATE are not completion events: they are emitted mid-flow, while an identification attempt is actively progressing through one of its sub-phases (typically on reinforced/second-provider identification flows). Each is fired the moment that sub-phase starts:

  • IDENTIFICATION_OPERATOR_CHECK_UPDATE: an operator live-check starts, or an in-progress live-check is suspended.
  • IDENTIFICATION_DOCUMENTS_UPDATE: document retrieval starts.
  • IDENTIFICATION_BIOMETRY_UPDATE: biometry retrieval starts.

Do not treat receiving one of these as a signal that the identification step is finished — the definitive outcome is only known once the enclosing Request transitions status (STATUS_UPDATE / STATUS_UPDATE_STEP) or is finalized (REQUEST_FINALIZED).

Enum extensibility

Every enum-shaped field in this document is an open enum: the listed values are the complete current set, but NOB may add new ones in a future, backward compatible release. Integrators must not reject a payload, or the webhook delivery, solely because it contains a value they do not yet recognize — unknown values should be tolerated (e.g. logged and treated as a generic/unmapped variant) rather than causing a hard failure.

Webhook authentication

Each WebhookConfiguration configures exactly one authentication method used by NOB when calling the integrator's endpoint (mutually exclusive, not combined): mutual TLS (MTLS), OAuth2 client-credentials (OAUTH2_CC), or a fixed set of custom headers (CUSTOM_HEADERS) sent with every delivery. The three security schemes below are documented as alternatives — the integrator's configuration determines which one actually applies.

Download OpenAPI description
openapi-1.json
openapi-1.yaml
Languages
Servers
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.

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)

Open-type enum. Current values:

  • 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_OPERATOR_CHANGED_DATA
  • 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_BIOMETRY_VIDEO_NOT_TAMPERED
  • ERROR_IDENTITY_ID_SELF_BIOMETRY_LIVENESS_SEQUENCE_CONSISTENCY
  • ERROR_IDENTITY_ID_SELF_BIOMETRY_LIVENESS_IS_ALIVE
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_VIDEO_NOT_TAMPERED
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_NOT_ORIGINAL
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_PICTURE_TAMPERED
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_FONT_NOT_FAITHFUL
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_NOT_ALLOWED
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_COUNTRY_UNAUTHORIZED
  • 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_IMAGE_NO_TEXT_FOUND
  • 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
  • ERROR_SIGN_EID_ASSERTION_EXPIRED
  • ERROR_SIGN_MISSING_SIGNATURE_FIELDS
  • CANCELLED_BY_USER
  • ERROR_IDENTITY_ID_SELF_STATUS_NOT_DONE
  • ERROR_SIGN_PHONE_NUMBER_ALREADY_TAKEN
  • ERROR_SIGN_GENERIC_TSP_SIGNING
  • ERROR_IDENTITY_ID_SELF_BIOMETRY_PHOTO_MISMATCH
  • ERROR_IDENTITY_ID_SELF_BIOMETRY_PASSIVE_LIVENESS
  • ERROR_IDENTITY_ID_SELF_BIOMETRY_PHOTO_MISMATCH_AND_PASSIVE_LIVENESS
  • ERROR_IDENTITY_IDHUB_OIDC_INVALID_REQUEST
  • ERROR_IDENTITY_IDHUB_OIDC_UNAUTHORIZED_CLIENT
  • ERROR_IDENTITY_IDHUB_OIDC_ACCESS_DENIED
  • ERROR_IDENTITY_IDHUB_OIDC_UNSUPPORTED_RESPONSE_TYPE
  • ERROR_IDENTITY_IDHUB_OIDC_INVALID_SCOPE
  • ERROR_IDENTITY_IDHUB_OIDC_SERVER_ERROR
  • ERROR_IDENTITY_IDHUB_OIDC_TEMPORARILY_UNAVAILABLE
  • ERROR_IDENTITY_IDHUB_OIDC_INTERACTION_REQUIRED
  • ERROR_IDENTITY_IDHUB_OIDC_LOGIN_REQUIRED
  • ERROR_IDENTITY_IDHUB_OIDC_ACCOUNT_SELECTION_REQUIRED
  • ERROR_IDENTITY_IDHUB_OIDC_CONSENT_REQUIRED
  • ERROR_IDENTITY_IDHUB_OIDC_UNKNOWN
  • ERROR_IDENTITY_ID_SELF_DEEP_FAKE_DETECTED
  • CANCELLED_BY_VERDICT
  • ERROR_IDENTITY_TOO_MANY_RETRIES
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_PICTURE_PRESENT
  • CANCELLED_BY_DEVICE_MISMATCH
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_MODEL_NOT_VALID
  • ERROR_DOC_PROCESSOR_PREVENT_CLIENT_SIDE
  • ERROR_DOC_PROCESSOR_PREVENT_SERVER_SIDE
customerAttributesobject(ObjectNode)

Lightweight store for additional string attributes for the Integrator. It may be limited in size (it is not intended to store files or large objects).

curl -i -X POST \
  'https://test-eu-ie1-api.namirialonboarding.com/api/v2/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": {
      "property1": {},
      "property2": {}
    },
    "settings": {
      "property1": {},
      "property2": {}
    },
    "operatorPending": true,
    "terminationReason": "string",
    "customerAttributes": {
      "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.
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.

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)
createdAtstring(date-time)(InstantDateTimeReadOnly)read-only
updatedAtstring(date-time)(InstantDateTimeReadOnly)read-only
finalizedAtstring(date-time)(InstantDateTimeReadOnly)read-only
expireAfterstring(date-time)(InstantDateTimeReadOnly)read-only
anonymizedAtstring(date-time)(InstantDateTimeReadOnly)read-only
operatorPendingboolean
terminationReasonstring(TerminationReason)

Open-type enum. Current values:

  • 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_OPERATOR_CHANGED_DATA
  • 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_BIOMETRY_VIDEO_NOT_TAMPERED
  • ERROR_IDENTITY_ID_SELF_BIOMETRY_LIVENESS_SEQUENCE_CONSISTENCY
  • ERROR_IDENTITY_ID_SELF_BIOMETRY_LIVENESS_IS_ALIVE
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_VIDEO_NOT_TAMPERED
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_NOT_ORIGINAL
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_PICTURE_TAMPERED
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_FONT_NOT_FAITHFUL
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_NOT_ALLOWED
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_COUNTRY_UNAUTHORIZED
  • 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_IMAGE_NO_TEXT_FOUND
  • 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
  • ERROR_SIGN_EID_ASSERTION_EXPIRED
  • ERROR_SIGN_MISSING_SIGNATURE_FIELDS
  • CANCELLED_BY_USER
  • ERROR_IDENTITY_ID_SELF_STATUS_NOT_DONE
  • ERROR_SIGN_PHONE_NUMBER_ALREADY_TAKEN
  • ERROR_SIGN_GENERIC_TSP_SIGNING
  • ERROR_IDENTITY_ID_SELF_BIOMETRY_PHOTO_MISMATCH
  • ERROR_IDENTITY_ID_SELF_BIOMETRY_PASSIVE_LIVENESS
  • ERROR_IDENTITY_ID_SELF_BIOMETRY_PHOTO_MISMATCH_AND_PASSIVE_LIVENESS
  • ERROR_IDENTITY_IDHUB_OIDC_INVALID_REQUEST
  • ERROR_IDENTITY_IDHUB_OIDC_UNAUTHORIZED_CLIENT
  • ERROR_IDENTITY_IDHUB_OIDC_ACCESS_DENIED
  • ERROR_IDENTITY_IDHUB_OIDC_UNSUPPORTED_RESPONSE_TYPE
  • ERROR_IDENTITY_IDHUB_OIDC_INVALID_SCOPE
  • ERROR_IDENTITY_IDHUB_OIDC_SERVER_ERROR
  • ERROR_IDENTITY_IDHUB_OIDC_TEMPORARILY_UNAVAILABLE
  • ERROR_IDENTITY_IDHUB_OIDC_INTERACTION_REQUIRED
  • ERROR_IDENTITY_IDHUB_OIDC_LOGIN_REQUIRED
  • ERROR_IDENTITY_IDHUB_OIDC_ACCOUNT_SELECTION_REQUIRED
  • ERROR_IDENTITY_IDHUB_OIDC_CONSENT_REQUIRED
  • ERROR_IDENTITY_IDHUB_OIDC_UNKNOWN
  • ERROR_IDENTITY_ID_SELF_DEEP_FAKE_DETECTED
  • CANCELLED_BY_VERDICT
  • ERROR_IDENTITY_TOO_MANY_RETRIES
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_PICTURE_PRESENT
  • CANCELLED_BY_DEVICE_MISMATCH
  • ERROR_IDENTITY_ID_SELF_DOCUMENT_MODEL_NOT_VALID
  • ERROR_DOC_PROCESSOR_PREVENT_CLIENT_SIDE
  • ERROR_DOC_PROCESSOR_PREVENT_SERVER_SIDE
customerAttributesobject(ObjectNode)

Lightweight store for additional string attributes for the Integrator. It may be limited in size (it is not intended to store files or large objects).

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": {
    "property1": {},
    "property2": {}
  },
  "settings": {
    "property1": {},
    "property2": {}
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "finalizedAt": "2019-08-24T14:15:22Z",
  "expireAfter": "2019-08-24T14:15:22Z",
  "anonymizedAt": "2019-08-24T14:15:22Z",
  "operatorPending": true,
  "terminationReason": "string",
  "customerAttributes": {
    "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.

Examples:
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.

Examples:
status=RUNNING
referenceIdstring

Used to filter requests by their referenceId.

Examples:
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.

createdAtFromstring(date-time)(InstantDateTime)

Filter requests created at or after this instant (inclusive). ISO-8601 UTC format (e.g. 2024-01-01T00:00:00Z).

createdAtTostring(date-time)(InstantDateTime)

Filter requests created at or before this instant (inclusive). ISO-8601 UTC format (e.g. 2024-12-31T23:59:59Z). Must be strictly after createdAtFrom when both are provided.

finalizedAtFromstring(date-time)(InstantDateTime)

Filter requests finalized at or after this instant (inclusive). ISO-8601 UTC format (e.g. 2024-01-01T00:00:00Z). Requests not yet finalized are excluded.

finalizedAtTostring(date-time)(InstantDateTime)

Filter requests finalized at or before this instant (inclusive). ISO-8601 UTC format (e.g. 2024-12-31T23:59:59Z). Requests not yet finalized are excluded. Must be strictly after finalizedAtFrom when both are provided.

curl -i -X GET \
  'https://test-eu-ie1-api.namirialonboarding.com/api/v2/requests?sort=string&page=0&size=0&status=string&referenceId=string&operatorPending=true&id=497f6eca-6276-4993-bfeb-53cbbbba6f08&requestTypeId=497f6eca-6276-4993-bfeb-53cbbbba6f08&organizationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&search=string&createdAtFrom=2019-08-24T14%3A15%3A22Z&createdAtTo=2019-08-24T14%3A15%3A22Z&finalizedAtFrom=2019-08-24T14%3A15%3A22Z&finalizedAtTo=2019-08-24T14%3A15%3A22Z' \
  -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)
createdAtStartstring(date-time)(InstantDateTime)
createdAtEndstring(date-time)(InstantDateTime)
requestTypeIdstring(uuid)
curl -i -X POST \
  https://test-eu-ie1-api.namirialonboarding.com/api/v2/requests/export \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
    "createdAtStart": "2019-08-24T14:15:22Z",
    "createdAtEnd": "2019-08-24T14:15:22Z",
    "requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329"
  }'

Responses

Ok,

Bodyapplication/json
any
Response
application/json
null

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

Info API

Public API for service information

Operations

webhooks

Webhooks

Signature API

Operations

Verdict API

Operations

Document Check

Operations

Doc Verification API

Operations

Identity Verification API

Operations

Request Amendment API

Operations