Send Invitation

Send an invitation to a user to complete a given workflow.

Endpoint


POST https://api.smart-kyc.com/api/manager/external/workflows/{workflowId}/invite

Request Headers


accept: application/json
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN

Path Parameters

workflowId: You can get this from the View Workflows endpoint

Request Body


{
  "email": "string",
  "expiresAt": "2026-01-15T16:06:17.857Z"
}

Parameters:

email: Email address to send the invitation to
expiresAt (optional): Invitation expiration date in ISO 8601 format (default: 5 days from now)

Example Request


curl -X 'POST' \
  'https://api.smart-kyc.com/api/manager/external/workflows/{workflowId}/invite' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -d '{
  "email": "user@example.com",
  "expiresAt": "2026-01-15T16:06:17.857Z"
}'

Response

200 OK


{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

You can use the invitation ID for reference in webhook events for submission approval and rejection.

404 Not Found


{
  "type": "about:blank",
  "title": "KnownRuntimeError",
  "status": 404,
  "detail": "Account not found",
  "instance": "/api/manager/external/workflows/{workflowId}/invite",
  "timestamp": 1768492024086,
  "full-path": "https://api.smart-kyc.com/api/manager/external/workflows/{workflowId}/invite"
}

Next Steps

After sending an invitation:

The user will receive an email with a link to complete the workflow
Monitor webhook events to receive notifications when the workflow is completed
Use the invitation ID to track the status of the KYC application