Create a client
OAuth scope: client.write
Creates a single client for the authenticated organization.
There is no uniqueness rule. It is strongly advised to search using the GET /v2/clients endpoint for a given client before creating a new client.
Price plans: this endpoint is available for all Qonto price plans.
POST
Authorizations
Bearer authorization header: Bearer <token>
, where <token>
is the access token received from the authorization server at the end of the OAuth 2.0 flow.
Headers
Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.
Body
application/json
When creating a client to be used for **invoicing purposes**, do note:
- A client can be created by only specifying a `type` and a `name` (depending on the chosen `type`);
- however, to be able to use that client for invoicing, the following additional fields must also be provided:
- `currency`
- `locale`
- address, either as root-level fields (`address`, `city`, `zip_code`, `province_code` and `country_code`) or inside the `billing_address` field object.
The body is of type object
.
The body is of type object
.
The body is of type object
.
Response
200
application/json
Returns the client created.
The response is of type object
.