Skip to content
DEVELOPER DOCUMENTATION
/
/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.
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

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://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/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"
      }
    }
  }'

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://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/dataHub/{id}' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Responses

Data intelligence process retrieved successfully.

Bodyapplication/json
idstring
statusstring
digitalFootprintScorestring
identityDocumentScorestring
Response
application/json
{
  "id": "string",
  "status": "string",
  "digitalFootprintScore": "string",
  "identityDocumentScore": "string"
}

Signature API

Operations