Transactions

Operation HTTP Request Description
create
POST /transactions
Create a transaction
delete
DELETE /transactions/{transaction_id}
Delete a transaction
get
GET /transactions/{transaction_id}
Get a transaction
update
PUT /transactions/{transaction_id}
Update a transaction

Registered office address

Operation HTTP Request Description
create
POST /transactions/{transaction_id}/registered-office-address
Create a registered office address resource
get
GET /transactions/{transaction_id}/registered-office-address
Get a registered office address resource
put
PUT /transactions/{transaction_id}/registered-office-address
Replace a registered office address resource
validate
GET /transactions/{transaction_id}/registered-office-address/validation-status
Get validation status for a registered office address resource

Registered email address

Operation HTTP Request Description
create
POST /transactions/{transaction_id}/registered-email-address
Create a registered email address filing resource
eligibility
GET /registered-email-address/company/{company_number}/eligibility
Get eligibilty of a company for registered email address
get
GET /transactions/{transaction_id}/registered-email-address
Get registered email address filing resource
put
PUT /transactions/{transaction_id}/registered-email-address
Replace a registered email address filing resource
validate
GET /transactions/{transaction_id}/registered-email-address/validation-status
Get validation status for a registered email address filing resource

Insolvency

Operation HTTP Request Description
create appointment
POST /transactions/{transaction_id}/insolvency/practitioners/{practitioner_id}/appointment
Appoint the practitioner
create attachment
POST /transactions/{transaction_id}/insolvency/attachments
Send a file attachment for the case
create insolvency resource
POST /transactions/{transaction_id}/insolvency
Create an insolvency transaction resource
create practitioner
POST /transactions/{transaction_id}/insolvency/practitioners
Create a practitioner for this insolvency resource
create progress report
POST /transactions/{transaction_id}/insolvency/progress-report
Send progress report details for this transaction
create resolution
POST /transactions/{transaction_id}/insolvency/resolution
Send resolution details for this transaction
create statement of affairs
POST /transactions/{transaction_id}/insolvency/statement-of-affairs
Send statement of affairs details for this transaction
delete appointment
DELETE /transactions/{transaction_id}/insolvency/practitioners/{practitioner_id}/appointment
Delete the appointment resource
delete attachment
DELETE /transactions/{transaction_id}/insolvency/attachments/{attachment_id}
Delete an attachment from this transaction
delete practitioner
DELETE /transactions/{transaction_id}/insolvency/practitioners/{practitioner_id}
Delete the practitioner from this insolvency resource
delete progress report
DELETE /transactions/{transaction_id}/insolvency/progress-report
Delete the progress report
delete resolution
DELETE /transactions/{transaction_id}/insolvency/resolution
Delete the resolution date
delete statement of affairs
DELETE /transactions/{transaction_id}/insolvency/statement-of-affairs
Delete the statement of affairs
download attachment
GET /transactions/{transaction_id}/insolvency/attachments/{attachment_id}/download
Download the attachment
get all practitioners
GET /transactions/{transaction_id}/insolvency/practitioners
Get all practitioners
get appointment
GET /transactions/{transaction_id}/insolvency/practitioners/{practitioner_id}/appointment
Get the appointment details
get attachment
GET /transactions/{transaction_id}/insolvency/attachments/{attachment_id}
Get information about the attachment that was submitted
get practitioner
GET /transactions/{transaction_id}/insolvency/practitioners/{practitioner_id}
Get the practitioner resource
get progress report
GET /transactions/{transaction_id}/insolvency/progress-report
Get Progress Report
get resolution details
GET /transactions/{transaction_id}/insolvency/resolution
Get the resolution details
get statement of affairs
GET /transactions/{transaction_id}/insolvency/statement-of-affairs
Get Statement of Affairs
validate insolvency resource
GET /transactions/{transaction_id}/insolvency/validation-status
Validate insolvency transaction resource