Onboard Buyer

post

https://api.demo.mondu.ai/api/v1/buyers

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, 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.

Body Params

legal_form_type

string

enum

required

Legal form of the company

Allowed:

company_name

string

length between 1 and 1024

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

registration_number

string

length ≥ 1

Official registration number

duns_number

string

length ≥ 1

Dun & Bradstreet D-U-N-S Number

registrar_name

string

length between 1 and 1024

Official registrar, e.g. UK Companies House

first_name

string

length between 1 and 1024

Mandatory if the legal form type is freelancer or partnership

last_name

string

length between 1 and 1024

Mandatory if the legal form type is freelancer or partnership

expected_exposure_cents

integer

≥ 1

Approximate expected exposure of the buyer

birth_date

date

Mandatory if the legal form type is freelancer

registration_address

object

required

Official Registration address of the buyer

applicant

object

required

Responses

403

Forbidden

422

Unprocessable Entity

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201successful