Content Comparison

...

• requestTypeId : Identifier of the type of process associated to 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

• settings (optional): here is possible to set some specific settings of the new request:

  • wizardUrlBack: url to redirect the user when the process is complete.
    Placehoders:

    • <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

curl -X POST "https://test.onboarding.namirial.app/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": {
    "customerName": "John Doe",
    "customerEmail": "john.doe@example.com"
  },
  "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.

...