Send a file attachment for the case

Request

POST https://api.company-information.service.gov.uk/transactions/{transaction_id}/insolvency/attachments

Path parameters

Parameter name Value Description Additional
transaction_id string

The transaction unique reference

Required

Request body

The request body takes a complete writeable attachment resource, containing the following writable properties:

{
    "attachment_type": "string",
    "file": [
        "binary"
    ]
}

Properties

Name Type Description Additional
attachment_type string

Possible values are:

  • resolution
  • statement-of-affairs-director
  • statement-of-concurrence
  • progress-report
file[] array of binary

Authorisation

This request requires the use of one of following authorisation methods: OAuth2.

For OAuth 2 authorisation, the following scopes are required:

Scope Description
https://api.company-information.service.gov.uk/company/*/insolvency.write-full Grants full Insolvency Practitioner access
https://identity.company-information.service.gov.uk/user/profile.read User profile read permission

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created

The file was accepted for processing

created attachment
400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Transaction not found