Content Comparison

This API call allows you to create a new onboarding request.

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)

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.

Example Request Body

{
  "requestTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceId": "order-1234-0002"
}

Responses

• 200 OK

  • Description: The created request.

  • Example Response:

    Code Block
    { "id": "123e4567-e89b-12d3-a456-426614174001", "organizationId": "123e4567-e89b-12d3-a456-426614174002", "status": "CREATED", "referenceId": "order-1234-0002", "requestTypeId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2024-10-29T17:42:16Z", "updatedAt": "2024-10-29T17:42:16Z", "finalizedAt": null, "expireAfter": "2024-11-29T17:42:16Z" }

• 400 Bad Request

  • Description: Bad Request described following Problem Details (RFC 9457).

  • Example Response:

    Code Block

    { "type": "about:blank", "status": 400, "title": "Request validation error", "detail": "The has a malformed body property.", "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463", "retryable": false, "errors": [ { "detail": "Property 'dummyField' is not defined in the schema and the schema does not allow additional properties.", "pointer": "/parameters/dummyField", "field": "dummyField", "reason": "additionalProperties" } ] }