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

Get request type webhooks configurations

Request

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

Responses

The webhook configurations for the specified request type

Bodyapplication/json
contentArray of objects(WebhookConfiguration)
Response
application/json
"{\n  \"content\": [\n    {\n      \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"url\": \"https://your.domain/webhook\",\n      \"createdAt\": \"2024-10-22T12:19:12.269594Z\"\n    }\n  ]\n}\n"

Create request type webhooks setting

Request

Security
ApiKeyAuth
Path
idstring(uuid)required
Bodyapplication/json
authenticationobject(RequestNotificationAuthentication)
urlstring(url)required
Example: "https://your.domain/webhook"
topicsArray of strings
Items Enum"REQUEST_STATUS""REQUEST_LIFECYCLE"
curl -i -X POST \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/requestType/{id}/webhookConfigurations' \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "authentication": {
      "headers": {
        "property1": "string",
        "property2": "string"
      },
      "client_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIH/TCCBeWgAwIBAgIQaBYE3/M08XHYCnNVmcFBcjANBgkqhkiG9w0BAQsFADBy\nMQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVGV4YXMxEDAOBgNVBAcMB0hvdXN0b24x\nETAPBgNVBAoMCFNTTCBDb3JwMS4wLAYDVQQDDCVTU0wuY29tIEVWIFNTTCBJbnRl\ncm1lZGlhdGUgQ0EgUlNBIFIzMB4XDTIwMDQwMTAwNTgzM1oXDTIxMDcxNjAwNTgz\nM1owgb0xCzAJBgNVBAYTAlVTMQ4wDAYDVQQIDAVUZXhhczEQMA4GA1UEBwwHSG91\nc3RvbjERMA8GA1UECgwIU1NMIENvcnAxFjAUBgNVBAUTDU5WMjAwODE2MTQyNDMx\nFDASBgNVBAMMC3d3dy5zc2wuY29tMR0wGwYDVQQPDBRQcml2YXRlIE9yZ2FuaXph\ndGlvbjEXMBUGCysGAQQBgjc8AgECDAZOZXZhZGExEzARBgsrBgEEAYI3PAIBAxMC\n-----END RSA PRIVATE KEY-----\n",
      "client_cert": "-----BEGIN CERTIFICATE-----\nMIIH/TCCBeWgAwIBAgIQaBYE3/M08XHYCnNVmcFBcjANBgkqhkiG9w0BAQsFADBy\nMQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVGV4YXMxEDAOBgNVBAcMB0hvdXN0b24x\nETAPBgNVBAoMCFNTTCBDb3JwMS4wLAYDVQQDDCVTU0wuY29tIEVWIFNTTCBJbnRl\ncm1lZGlhdGUgQ0EgUlNBIFIzMB4XDTIwMDQwMTAwNTgzM1oXDTIxMDcxNjAwNTgz\nM1owgb0xCzAJBgNVBAYTAlVTMQ4wDAYDVQQIDAVUZXhhczEQMA4GA1UEBwwHSG91\nc3RvbjERMA8GA1UECgwIU1NMIENvcnAxFjAUBgNVBAUTDU5WMjAwODE2MTQyNDMx\nFDASBgNVBAMMC3d3dy5zc2wuY29tMR0wGwYDVQQPDBRQcml2YXRlIE9yZ2FuaXph\ndGlvbjEXMBUGCysGAQQBgjc8AgECDAZOZXZhZGExEzARBgsrBgEEAYI3PAIBAxMC\n-----END CERTIFICATE-----\n"
    },
    "url": "https://your.domain/webhook",
    "topics": [
      "REQUEST_STATUS"
    ]
  }'

Responses

The webhook settings created

Bodyapplication/json
idstring(uuid)read-only

Id of the webhook configuration

authenticationobject(RequestNotificationAuthentication)
urlstring(url)required
Example: "https://your.domain/webhook"
createdAtobject(InstantDateTimeReadOnly)read-only
Example: "2024-10-22T12:19:12.269594Z"
topicsArray of strings
Items Enum"REQUEST_STATUS""REQUEST_LIFECYCLE"
Response
application/json
"{\n  \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"url\": \"https://your.domain/webhook\",\n  \"createdAt\": \"2024-10-22T12:19:12.269594Z\"\n}\n"

Delete the specified webhook setting

Request

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

Responses

The resource was deleted successfully.

Response
No content

Get default public request type settings

Request

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

Responses

The Default Request Type Settings

Bodyapplication/json
requestSettingsDefaultobject(ObjectNode)
Response
application/json
{
  "requestSettingsDefault": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  }
}

Add, delete or modify the default public request type settings

Request

Security
ApiKeyAuth
Path
idstring(uuid)required
Bodyapplication/json
requestSettingsDefaultobject(ObjectNode)
curl -i -X PUT \
  'https://docs.namirial.app/_mock/products/namirialonboarding/openapi-1/requestType/{id}/settings' \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "requestSettingsDefault": {
      "additionalProp0": "string",
      "property1": {},
      "property2": {}
    }
  }'

Responses

The Updated default public request type settings

Bodyapplication/json
requestSettingsDefaultobject(ObjectNode)
Response
application/json
{
  "requestSettingsDefault": {
    "additionalProp0": "string",
    "property1": {},
    "property2": {}
  }
}

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