Skip to content
DEVELOPER DOCUMENTATION
/
Namirial Onboarding
/
/DataHub API

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

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

Initiates a data intelligence workflow for identity verification

Request

Starts a Data Intelligence process to collect and analyze personal data for the purpose of verifying a user's identity. This may involve checks against official records, biometric data, and other sources to validate the identity in compliance with onboarding and regulatory requirements.

Security
ApiKeyAuth
Bodyapplication/json
referenceIdstring
requestTypeIdstringrequired
parametersobject
curl -i -X POST \
  https://test-eu-ie1-api.namirialonboarding.com/api/v2/dataHub \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "referenceId": "string",
    "requestTypeId": "string",
    "parameters": {
      "firstName": "string",
      "lastName": "string",
      "phoneNumber": "string",
      "email": "string",
      "personalNumber": "string",
      "gender": "string",
      "birthDate": "string",
      "nationality": "string",
      "identityVerification": {
        "documentDetails": {
          "issuanceCountry": "IT",
          "issuanceAuthority": "PREFECTURE",
          "type": "Passport",
          "number": "AB1234567",
          "issuedOn": "2024-01-15",
          "expiryDate": "2034-01-14"
        }
      },
      "digitalFootprint": {
        "ipAddress": "string"
      },
      "legalEntity": {
        "legalEntityName": "string",
        "legalEntityId": "string"
      }
    }
  }'

Responses

Request successfully received and the process has been initiated.

Bodyapplication/json
idstring
Response
application/json
{
  "id": "string"
}

Retrieves the status and results of a data intelligence process

Request

Fetches the current status and results of a previously initiated Data Intelligence process identified by the given ID. The response may include data validation outcomes, identity verification results, and other relevant insights gathered during the analysis.

Security
ApiKeyAuth
Path
idstring(uuid)required
curl -i -X GET \
  'https://test-eu-ie1-api.namirialonboarding.com/api/v2/dataHub/{id}' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

Data intelligence process retrieved successfully.

Bodyapplication/json
idstring
statusstring
digitalFootprintScorestring
identityDocumentScorestring
legalEntityScorestring
politicallyExposedPersonScorestring
antiTerrorismScorestring
adverseMediaScreeningScorestring
Response
application/json
{
  "id": "string",
  "status": "string",
  "digitalFootprintScore": "string",
  "identityDocumentScore": "string",
  "legalEntityScore": "string",
  "politicallyExposedPersonScore": "string",
  "antiTerrorismScore": "string",
  "adverseMediaScreeningScore": "string"
}

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