Create a PSC discrepancy report
POST https://api.company-information.service.gov.uk/psc-discrepancy-reports
The request body takes a complete DiscrepancyReportPost resource, containing the following writable properties:
{
"company_number": "string",
"material_discrepancies": [
"string"
],
"obliged_entity_contact_name": "string",
"obliged_entity_email": "string",
"obliged_entity_organisation_name": "string",
"obliged_entity_type": "string",
"status": "string"
}
Name | Type | Description | Additional |
---|---|---|---|
company_number | string | Optional | |
material_discrepancies[] | array of string |
Possible values are:
|
|
obliged_entity_contact_name | string | Optional | |
obliged_entity_email | string | Optional | |
obliged_entity_organisation_name | string | Optional | |
obliged_entity_type | string |
Possible values are:
|
Optional |
status | string |
Possible values are:
|
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/psc-discrepancy-reports.write-full | Grants full PSC Discrepancy report 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 PSC discrepancy report created. |
DiscrepancyReportResponse |
400 | Bad Request The body has errors. The correct error is displayed if a single element is omitted from the call but if multiple elements are left out not all errors are displayed. Eg if only the status is added to the body of a /psc-discrepancy-reports POST the only error that fires is for the obliged-entity type and not the other 4 fields that are missing. |
Error |
500 | Internal Server Error Internal Server Error |