Change provided company data

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Use this endpoint to update the fixedInfo.companyInfo object, which contains the company data provided by the applicant. This information is intended to be cross-checked against the company data extracted from documents (info.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 fixedInfo entity 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 pending by initiating another review.

Request examples

curl -X PATCH \
     'https://api.sumsub.com/resources/applicants/673f390478c5cc60a492aa39/fixedInfo/companyInfo' \
     -H 'accept: application/json' \
     -H 'content-type: application/json' \
     -H 'X-App-Token: <your-app-token>' \
     -H 'X-App-Access-Sig: <your-signature>' \
     -H 'X-App-Access-Ts: <unix-timestamp>' \
     -d '{
            "companyName": "Mega Corp",
            "registrationNumber": "123-456-789",
            "country": "USA",
            "alternativeNames": [
              "Mega",
              "Megacorp"
            ],
            "legalAddress": "New York, 100 Street",
            "incorporatedOn": "2020-05-25",
            "type": "Public Limited Company",
            "registrationLocation": "New York",
            "website": "www.website.com",
            "skippedTypes": [
              "ubo",
              "representative"
            ],
            "noDocs": false
          }'

Response explained

If the request is successfully sent and processed, you will get the following response indicating the data has been updated.

{
  "ok": 1
}
📘

Note

To get the applicant profile data, use the following method.

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'"
}

Path Params
string
required

Unique identifier of the company applicant in the Sumsub system.

This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant profile is created on the Sumsub side, and can be found in the Dashboard.

If the applicantId is unknown to you, use the Get applicant data (externalUserId) method to fetch it.

Body Params
string

Name of the company.

string

Unique number assigned to the company when it was registered as a legal entity.

string

Alpha-3 code of the country where the company is legally registered (for example, DEU, GBR, ARG, and so on).

alternativeNames
array of strings

Each string stands for an alternative name of the company: a brand name, business trademark, name in a local language, and so on. For example, "Megacorp" instead of "The Megacorp ABC Inc."

⚠️ If you want to add new names to the old ones, submit existing names in the request as well, otherwise the old names will be overwritten.

alternativeNames
string

Address a legal entity uses to register with a legal authority.

address
object

Company address details.

string

Date of company incorporation (format YYYY-mm-dd, e.g. 2001-09-25).

string

Type of legal entity. For example, Private Company Limited by Shares, Public Limited Company, Limited Partnership, and so on.

string

Company email address.

string

Company phone number.

string

Description of the control scheme of the company ownership or group of entities.

string

Applicant position in regards to the company.

string

Taxpayer registration number/Code of taxpayer registration.

string

Legal Entity Identifier (LEI) code. Refers to the public identifier from the financial entities registry.

string

City, town, or another location where the company was registered.

string

Website URL of the company.

string

Company postal address.

skippedTypes
array of strings

Include the required values (shareholder, ubo, representative, director) in the array to verify a company applicant without the corresponding entities specified in the company profile.

skippedTypes
boolean
Defaults to false

Indicates whether company documents must be uploaded to proceed verification.

  • true — uploading company documents is optional.
  • false (default) — at least one document must be uploaded.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!