Get info on a request

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

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": { "customerName": "John Doe", "customerEmail": "john.doe@example.com" }, "createdAt": "2024-10-29T17:42:16Z", "updatedAt": "2024-10-29T17:42:16Z", "finalizedAt": null, "expireAfter": "2024-11-29T17:42:16Z" }

• 404 Not Found

  • Description: The requested resource was not found.

  • Example Response:

    { "type": "about:blank", "status": 404, "title": "Not Found", "detail": "The requested resource was not found.", "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463", "retryable": false }