Sign in
Exemptions

Upload exemption certificate

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

Path parameters

exemption_idstring required

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

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

The unique identifier for the organization making the request

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' required
idstring required

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

Changes

Changed in 1 of the 4 revisions of this API.23

  • 6ba4f4c774c323See the full diff
    • ▲

      added the new required header request parameter x-organization-id

      new-required-request-parameter

    • ▲

      the request property contentMediaType changed from to application/octet-stream

      request-property-content-media-type-changed

    • ○

      the endpoint scheme security APIKeyHeader was added to the API

      api-security-added

    • ○

      the endpoint scheme security APIKeyHeader AND CustomHeader was removed from the API

      api-security-removed

    • ○

      the request property format was generalized from binary to no format

      request-property-type-generalized

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    This revision also has 362 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog