Content Comparison

...

• Accept: application/json

• Content-Type: 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 for which you want to generate links. This should be included in the URL path. Example: 123e4567-e89b-12d3-a456-426614174000

...

• onlyForActors (optional): An array of actor names for whom the links should be generated. If not provided, links will be generated for all actors. Example:

  Code Block
  language json
  { "onlyForActors": ["actor1", "actor2"] }

Example cURL API call

curl -X POST "https://test.onboarding.namirial.app/api/v2/request/YOUR_REQUEST_ID/links" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-d '{
  "onlyForActors": ["customer"]
}'

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

Responses

• 200 OK

  • Description: The generated links for the specified request.

  • Example Response:

    Code Block
    language json
    { "links": [ { "actor": "customer", "link": "https://onboarding.example/res/3949?ts=49943", "expiresAfter": "2024-11-29T17:42:16.269594Z" } ] }

• 400 Bad Request

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

  • Example Response:

    Code Block
    language json
    { "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 'actors' is not defined in the schema and the schema does not allow additional properties.", "pointer": "/actors", "field": "actors", "reason": "additionalProperties" } ] }