Send a file attachment for the case
POST https://api.company-information.service.gov.uk/transactions/{transaction_id}/insolvency/attachments
Parameter name | Value | Description | Additional |
---|---|---|---|
transaction_id | string | The transaction unique reference |
Required |
The request body takes a complete writeable attachment resource, containing the following writable properties:
{
"attachment_type": "string",
"file": [
"binary"
]
}
Name | Type | Description | Additional |
---|---|---|---|
attachment_type | string |
Possible values are:
|
|
file[] | array of binary |
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 |
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 |