TRtrykintsugi
Exemptions

Upload exemption certificate

Changed on

The Upload Exemption Certificate API allows you to upload a file attachment (e.g., exemption certificate) for a specific exemption. This is primarily used to associate supporting documents with an exemption record to ensure compliance and facilitate verification.

post/v1/exemptions/{exemption_id}/attachments

Request

  • Base URL
    https://api.trykintsugi.com
  • URL
    https://api.trykintsugi.com/v1/exemptions/{exemption_id}/attachments
  • Auth
    API key in header X-API-KEY

Path parameters

exemption_idstring required

The unique identifier for the exemption to which the attachment will be associated.

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

Request body multipart/form-data

filestring binary required

The file to be uploaded. Supported format: PDF. Max size: 10 MB.

Response

Successfully retrieved exemption by id

related_entity_idstring required

The unique identifier of the exemption associated with the attachment.

related_entity_type'EXEMPTION' | 'REGISTRATION' | 'FILING' | 'FILING_PAYMENT' | 'TASK' | 'FILING_PAYMENT_RECEIPT' | 'PROPOSAL' required
idstring required

The unique identifier of the uploaded attachment (attachment ID).

Changes

  • 49146194c72eRevision changes
    • warning

      added the new PROPOSAL enum value to the response property for the response status

  • fee3b20e8c20Revision changes
    • warning

      added the new FILING_PAYMENT_RECEIPT enum value to the response property for the response status