v1

latestOpenAPI 3.0.32026-08-0645108163.2 KB
Registration

Create a new entitlement registration line

Creates a new entitlement registration line with an optional file attachment.

Attachment Rules:

  • Whether an attachment is required or not allowed is determined by the entitlement configuration.
  • entitlements API can be used to fetch the entitlement configuration, which includes whether an attachment is required or not allowed for a specific entitlement.
  • If an attachment is required but not provided, the request will be rejected with a 400 error.
  • If an attachment is provided when not configured in entitlement, the document will still be stored
  • Supported file types for attachments are PDF, PNG and JPEG. If the provided file is not one of these types, the request will be rejected with a 400 error.
post/public/registrations/v1/register-entitlement

Response

Entitlement registration line created successfully

registrationIdstring uuid required

The ID of the created entitlement registration line

attachmentFileIdstring uuid

The ID of the uploaded attachment file. Null if no attachment was uploaded.