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

Create a new request with a preset data

This API call allows you to create a new onboarding request. The request includes all necessary information and parameters required to initiate the onboarding process.

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 -X POST "https://test-eu-ie1-api.namirialonboarding.com/api/v2/requests?idempotencyKey=YOUR_IDEMPOTENCY_KEY" \
-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": {
    "firstName": "Mario",
    "lastName": "Rossi",
    "personalNumber": "RSSMR000000"
  },
  "settings": {
    "wizardUrlBack": "https://webhook.site/2c47164f-fc65-44cd-a8c4-a2c806fb6c8a?requestId=<requestId>&referenceId=<referenceId>&status=<status>&requestTypeId=<requestTypeId>&actor=<actor>"
  }
}'

Replace YOUR_API_KEY with your actual API key, YOUR_REFERENCE_ID with your reference, and YOUR_IDEMPOTENCY_KEY with the idempotency key of the request.

Previous page
Next page