Get info on a request

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

This API call allows you to retrieve the details of a specific onboarding request by its unique identifier.

Endpoint

• URL: /request/{id}
• Method: GET

Headers

Ensure you include the following headers in your request:

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

Path parameters

• id (required): The unique identifier of the request you want to retrieve. This should be included in the URL path. Example: 123e4567-e89b-12d3-a456-426614174000

Example cURL API call

curl -X GET "https://test-eu-ie1-api.namirialonboarding.com/api/v2/request/YOUR_REQUEST_ID" \
-H "Accept: application/json" \
-H "X-Api-Key: YOUR_API_KEY"

Replace YOUR_API_KEY with your actual API key and YOUR_REQUEST_ID with the ID of the request.

Responses

• 200 OK

  • Description: The details of the requested onboarding request.

  • Example Response:

    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "123e4567-e89b-12d3-a456-426614174002",
      "status": "RUNNING",
      "referenceId": "order-1234-0002",
      "requestTypeId": "123e4567-e89b-12d3-a456-426614174000",
      "parameters": {
        "firstName": "Mario",
        "lastName": "Rossi",
        "personalNumber": "RSSMR000000"
      },
      "createdAt": "2024-10-29T17:42:16Z",
      "updatedAt": "2024-10-29T17:42:16Z",
      "finalizedAt": null,
      "expireAfter": "2024-11-29T17:42:16Z"
    }