Add or update onboarding data

Use this endpoint to add or change the information Verto needs to onboard one of your sub-accounts: its details, products, addresses, directors and shareholders, documents and risk assessment answers. Send only what you want to add or change (except selectedProducts, which replaces the whole list), as often as you need. The response returns the application as it now stands.

📘

Saving does not submit the application.

When everything is in place, check it with Get submission checks, then call Submit application. For Atlas for Platform, each save also starts Verto's background checks; their findings appear in Get submission checks.

Where this fits

  1. Save the sub-account's information with this endpoint, in one call or several.
  2. Call Get submission checks to see what is still missing or needs fixing.
  3. Fix the issues with another save, then check again.
  4. When there are no BLOCKING issues and you have reviewed any WARNING issues, call Submit application.

What you can send

PartWhat it holdsHow it is saved
selectedProductsThe Verto products the sub-account wants to useReplaces the whole list each time
companyThe sub-account's own details, such as its legal name, registration number and industryOnly the fields you send are changed
companyAddressesThe registered address and, if different, the operating address (up to 2 per request)Matched by address type
shareholdersDirectors, shareholders, owners and authorised signatories (up to 5 changes per request)Existing ones are matched by id
companyDocumentsDocuments about the sub-account itself (up to 5 changes per request)Existing ones are matched by document id
shareholderDocumentsDocuments for a specific director, shareholder, owner or authorised signatory (up to 5 changes per request)Existing ones are matched by document id and shareholderId
riskAssessmentAnswers to Verto's risk assessment questionsSaved per question
🚧

selectedProducts replaces the whole list.

Unlike the other parts, it isn't merged. If you send selectedProducts, send every product the sub-account wants; any you leave out are removed.

Actions

Addresses, shareholders and documents each take an action:

ActionWhat it does
ADDAdds a new entry. For addresses, adding a type that already exists replaces it.
UPDATEChanges an existing entry.
DELETERemoves an entry. Documents Verto has approved or is reviewing can't be deleted.
ARCHIVESets a director, shareholder or owner aside without removing them. Shareholders only.
UNARCHIVEBrings an archived director, shareholder or owner back. Shareholders only.

What you get back

The application as it now stands: the sub-account's details and addresses, products, directors and shareholders, documents and risk assessment answers, plus:

  • status: the application's overall status (not the background-check status from Get submission checks): IN_PROGRESS while it is being filled in, then APPROVED or REJECTED after Verto's review.
  • progress: how complete each section is, as a percentage. To decide what to fix, use Get submission checks rather than progress.
Path Params
string
required

company id

Body Params
selectedProducts
array of strings
length ≥ 1

A list of one or more Verto product names the sub-account wants to use, for example Business Accounts or Expense Management.

selectedProducts
company
object

The sub-account's own details, such as its legal name, registration number, industry and contact details. In a request, only the fields you include are changed.

companyAddresses
array of objects
length ≤ 2

The sub-account's addresses: its registered address (COMPANY_ADDRESS) and, if different, its operating address (OPERATING_ADDRESS). Up to two entries, one per address type. Submission checks refer to them as companyAddresses.COMPANY_ADDRESS and companyAddresses.OPERATING_ADDRESS.

companyAddresses
shareholders
array of objects
length ≤ 5

The sub-account's directors, shareholders, owners and authorised signatories, both individuals and corporate entities. Up to five changes per request.

shareholders
companyDocuments
array of objects
length ≤ 5

Documents about the sub-account itself, such as its certificate of incorporation or proof of address. Up to five changes per request.

companyDocuments
shareholderDocuments
array of objects
length ≤ 5

Documents for a specific director, shareholder, owner or authorised signatory, such as an ID or proof of address. Up to five changes per request.

shareholderDocuments
riskAssessment
array of objects

A list of answers to Verto's risk assessment questions, one entry per question.

riskAssessment
Responses

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