Overview
Use this endpoint to update the info.companyInfo object, which contains company data extracted from documents. This data is intended to be cross-checked against the provided company information (fixedInfo.companyInfo).
This method allows you to update existing company information without creating a new profile—simply submit this PATCH request with the new data.
Important
- Submitting new information will overwrite the previously stored data. To retain current values, omit those fields from the request payload.
- A patched
infoentity could be quite damaging if misused. It is recommended to check in the sandbox environment if the response returns expected results.
Note
If you need to re-check the company once the information has been changed, you need to revert the company verification status to
pendingby initiating another review.
Request examples
In the following request examples, you can see the difference between requests for KYB 1.0 and KYB 2.0 applicants.
curl -X PATCH \
'https://api.sumsub.com/resources/applicants/5b76df770a975a1404cbcb60/info/companyInfo' \
-H 'Content-Type: application/json' \
-d '{
"companyName": "your_company_name",
"registrationNumber": "7836733",
"country": "GBR",
"website": "yourcompany.com",
"noUBOs": false,
"beneficiaries": [
{
"applicantId": "5e95717e0a975a723e187cde",
"positions": null,
"type": "ubo",
"inRegistry": false,
"imageIds": null,
"applicant": null
},
{
"applicantId": "5e9571a30a975a723e187ce9",
"positions": ["shareholder"],
"type": "shareholder",
"inRegistry": false,
"imageIds": null,
"applicant": null
}
]
}'
curl -X PATCH \
'https://api.sumsub.com/resources/applicants/5b76df770a975a1404cbcb60/info/companyInfo' \
-H 'Content-Type: application/json' \
-d '{
"companyName": "your_company_name",
"registrationNumber": "7836733",
"country": "GBR",
"website": "yourcompany.com",
"noUBOs": false,
"beneficiaries": [
{
"id": "123e4567-e89b-12d3-a456-426655440000",
"types": [
"shareholder",
"representative"
],
"shareSize": 10
},
{
"id": "987e6543-e89b-12d3-a456-426655440000",
"types": [
"shareholder"
],
"shareSize": 12
}
]
}'
Response explained
If the request is successfully sent and processed, you will get a JSON file that contains the companyInfo object with the data changed.
You can see the companyInfo structure and possible content with descriptions in the following table.
Response examples
If the request is successfully sent and processed, you will get a response like one of those below.
{
"companyName": "your_company_name",
"registrationNumber": "7836733",
"country": "GBR",
"website": "yourcompany.com",
"noUBOs": false,
"beneficiaries": [
{
"applicantId": "5e95717e0a975a723e187cde",
"positions": null,
"type": "ubo",
"inRegistry": false,
"imageIds": null,
"applicant": null
},
{
"applicantId": "5e9571a30a975a723e187ce9",
"positions": [
"shareholder"
],
"type": "shareholder",
"inRegistry": false,
"imageIds": null,
"applicant": null
}
]
}
{
"companyName": "your_company_name",
"registrationNumber": "7836733",
"country": "GBR",
"website": "yourcompany.com",
"noUBOs": false,
"beneficiaries": [
{
"id": "123e4567-e89b-12d3-a456-426655440000",
"types": [
"shareholder",
"representative"
],
"shareSize": 10
},
{
"id": "987e6543-e89b-12d3-a456-426655440000",
"types": [
"shareholder"
],
"shareSize": 12
}
]
}
If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:
{
"code": 400,
"correlationId": "27b05e3e3a94851dc0d7caef793ab82d",
"errorCode": 0,
"description": "Invalid id '673390478c5cc60a492aa39'"
}