API Reference
Status PageRoadmapTestimoniesShare feedback

Initiate a new Company Verification

post
https://api-sandbox.yousign.app/v3/verifications/companies

Initiate a new Company Verification by providing the company number or by uploading a document containing company information.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

Please provide the exact company number depending on the country format. For any doubt, consult the Company Verification guide.

string
enum
required
length between 2 and 2

Defines the country where the company is registered.

uuid | null

Scopes the verification to a specific workspace. Defaults to the default workspace if not specified.

uuid | null

Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.

uuid | null

ID of the previous attempt within the same workflow_session_id. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.

string | null

The company name. Required for German (DE) companies.
When country_code is DE, this field must be provided.
This property is a Safe String.

string | null

Additional search field. Only accepted when country_code is DE.
For DE, it must be a 5-digit Postleitzahl (e.g. "10115").
Helps narrow the company lookup when several companies share similar names.
This property is a Safe String.

string | null

Additional search field. Only accepted when country_code is DE.
Helps narrow the company lookup when several companies share similar names.
This property is a Safe String.

string | null

Additional search field. Only accepted when country_code is DE.
Helps narrow the company lookup when several companies share similar names.
This property is a Safe String.

string | null

Additional search field. Only accepted when country_code is DE.
The German commercial register court (Registergericht) handling the company.
This property is a Safe String.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 28 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 28 days ago