Onboard Buyer

Buyer Onboarding

This endpoint is used to onboard a new buyer. The buyer can be an individual or a company. The buyer can be onboarded with the following legal form types:

Along with the mandatory fields, the following fields are required based on the legal form type:

  • registered_company: The buyer is a registered company, company name, registrar name, and either registration_number or duns_number is required. vat_number alone does not satisfy this.
  • freelancer: The buyer is a freelancer, first name, last name, and birth date are required.
  • partnership: The buyer is a partnership, first name and last name are required.
  • public_institution: The buyer is a public institution, company name is required.
  • registered_association: The buyer is a registered association, company name is required.

Before calling this endpoint, the buyer must consent to Mondu processing their data for the onboarding. Confirm it with terms_accepted: true, and optionally send the link to the terms they accepted in terms_url. Without that confirmation the request is rejected with 422 and the buyer is not onboarded.

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

Use Case:

  • This endpoint is used to onboard a new buyer.
  • The buyer can be an individual or a company.
  • The buyer can be onboarded with the following legal form types. Along with the mandatory fields, the following fields are required based on the legal form type:
    • registered_company: The buyer is a registered company, registration number and registrar name are required.
    • freelancer: The buyer is a freelancer, first name, last name, and birth date are required.
    • partnership: The buyer is a partnership, first name and last name are required.
    • public_institution: The buyer is a public institution, company name is required.
    • registered_association: The buyer is a registered association, company name is required.

The optional registration_number and duns_number fields help better identify the buyer.

Important

  • Use this endpoint only when advised by Mondu Integration Team.
Body Params
Allowed:
string
length between 1 and 1024

Mandatory if the legal form type is registered_company, public_institution or
registered_association

string
length ≥ 1

Official registration number. For registered_company, either registration_number or duns_number is required

string
length ≥ 1

Dun & Bradstreet D-U-N-S Number. For registered_company, either registration_number or duns_number is required

string
length between 1 and 1024

Official registrar, e.g. UK Companies House. Mandatory if the legal form type is registered_company

string
length ≥ 1

VAT number. Optional; does not replace registration_number or duns_number

string
length between 1 and 1024

Mandatory if the legal form type is freelancer or partnership

string
length between 1 and 1024

Mandatory if the legal form type is freelancer or partnership

integer
≥ 1

Approximate expected exposure of the buyer

date

Mandatory if the legal form type is freelancer

registration_address
object
required

Official Registration address of the buyer

applicant
object
required
boolean
enum
required

Confirms that the buyer consented to Mondu processing their data for the onboarding. Must be true; a request without it or with false is rejected with 422 and the buyer is not onboarded

Allowed:
string
length ≤ 2048
^https?://.+$

Optional link to the terms the buyer accepted, stored with the consent

Responses

403

Forbidden

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