Skip to content
DEVELOPER DOCUMENTATION
/
/
/
Create a new request with...
Last updated

Create a new request with only DataHub

This API call initiates a data intelligence workflow for identity verification. Since there's no identification process, all parameters for digital footprint processes and/or identity verification must be passed in as input.

Endpoint

  • URL: /requests
  • Method: POST

Headers

Ensure you include the following headers in your request:

  • Accept: application/json
  • Content-Type: application/json
  • X-Api-Key: YOUR_API_KEY (replace YOUR_API_KEY with your actual API key)

Query parameters

  • idempotencyKey (optional): This query parameter ensures that the request is idempotent. If the endpoint has already received a request with the same IdempotencyKey in the last 7 days, it replies with the same body that was sent the first time. This prevents duplicate requests.

Body parameters

  • requestTypeId: Identifier of the type of process associated with the request. This identifier is given to the Integrator during initial setup of the integration project.
  • referenceId (optional): Field of the request that maps to an identifier relevant to the Integrator's system. It is not used internally by Namirial Onboarding but helps the integrator track and manage requests within their own systems
  • <parameters>: If this part is empty, an anonymous request is being created. In the case of a request with a signature, which therefore requires the issuance of a disposable certificate, the parameters' email' and 'phoneNumber' are mandatory.
  • settings (optional): here, it is possible to set some specific settings of the new request:

    • wizardUrlBack: URL to redirect the user when the process is complete
      Placeholders:

      • <requestId>
      • <referenceId>
      • <status>: final status of the request
      • <requestTypeId>
      • <actor>: is the role of the customer in the Namirial Onboarding process, usually userToIdentify

Example cURL API call

We can define a sample payload that includes all necessary fields for successfully testing an onboarding and signing process. The payload below is for illustrative purposes only.

curl --location 'https://test-eu-ie1-api.namirialonboarding.com/api/v2/dataHub' \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-d '{
  "requestTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceId": "YOUR_REFERENCE_ID",
  "parameters": {
    "lastName": "ROSSI",
    "firstName": "MARIO",
    "email": "mario.rossi@example.it",
    "phoneNumber": "+393333333333",
    "personalNumber": "XXXXXX90R50I608X",
    "birthDate": "1990-10-10",
    "gender": "M",
    "nationality": "IT",
    "digitalFootprint": {
      "ipAddress": "XXX.XX.XXX.XX"
    }
  }
}'

Replace YOUR_API_KEY with your actual API key.

This payload includes many elements:

requestTypeId: identifies the entire process for obtaining the digital footprint outcome. parameters: it is necessary to provide all the parameters to verify the identity of a person digitalFootprint: is needed to provide all the parameters to verify the digital identity of a person

Example cURL API call DOCUMENT VERIFICATION

The payload below is for illustrative purposes only.

curl --location 'https://test-eu-ie1-api.namirialonboarding.com/api/v2/dataHub' \
--header 'Content-Type: application/json' \
--header 'content-type: application/json' \
--header 'X-Api-Service: YOUR_API_KEY' \
--data-raw '{
  "requestTypeId": "123e4567-e89b-12d3-a456-426614174000",
"parameters": {
    "lastName": "ROSSI",
    "firstName": "MARIO",
    "personalNumber": "XXXXXX90R50I608X",
    "birthDate": "1990-10-10",
    "gender": "F",
    "nationality": "IT",
    "identityVerification": {
      "documentDetails": {
        "issuanceCountry": "IT",
        "type": "DrivingLicense",
        "number": "XX1010010X",
        "issuedOn": "2023-01-01",
        "expiryDate": "2033-01-010",
        "issuanceAuthority": "PREFECTURE"
      }
    }
  }
}'

This payload includes many elements:

  • requestTypeId: identifies the entire process for obtaining the digital footprint outcome.
  • parameters: it is necessary to provide all the parameters to verify the identity of a person
  • identityVerification: is needed to provide all the parameters to verify the identity of a person
Previous page
Next page