Overview
Use this endpoint to change the company data. With this method, you patch the fields in the companyInfo object of the company profile.
This method is rather beneficial because you do not need to create another profile when obtaining new information about the company, you just make this PATCH request instead.
Mind that 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.
Note
For KYB 2.0 applicants, the method updates the Extracted Company Data section of the profile as presented in the Dashboard. This is the information extracted from registries and/or documents.
Important
- When making a request, the body parameters must contain all of the fields that have values. Null fields at the
companyInfowill be unset. You can get the previously filled data with this method.- A patched
infoentity could be quite damaging if misused. It is recommended to check in the sandbox environment if the response returns expected results.
Request examples
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
{
"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
}
]
}