curl --request POST \
--url https://thirdparty-sandbox.staging.qonto.co/register/registrations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Qonto-Partner-Id: <api-key>' \
--data '
{
"legal_flow": "existing_company",
"locale": "en",
"partner_redirect_url": "https://example.com/users/123456/dashboard",
"partner_user": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe"
},
"organization": {
"legal_number": "123232323"
}
}
'{
"registration": {
"locale": "fr",
"partner_user": {
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]"
},
"organization": {
"legal_name": "Olinda",
"legal_form": "SAS",
"address": {
"line_1": "Rue La Fayette 20B",
"postal_code": "75009",
"city": "Paris",
"country": "FR",
"line_2": "Room 5"
},
"total_capital_amount": {
"value": "1023.43",
"currency": "EUR"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_type": "company",
"legal_number": "<string>",
"legal_sector": "K.64.11",
"legal_registration_date": "2023-12-25",
"legal_vat_number": "<string>"
},
"stakeholders": [
{
"capital_amount": {
"value": "1023.43",
"currency": "EUR"
},
"is_owner": true,
"first_name": "Leeroy",
"last_name": "Jenkins",
"email": "[email protected]",
"gender": "male",
"phone_number": "0033123456789",
"nationality": "FR",
"birth_date": "2021-08-17T12:31:32.689Z",
"birth_address": {
"postal_code": "75009",
"city": "Paris",
"country": "FR"
},
"residence_address": {
"line_1": "Rue La Fayette 20B",
"postal_code": "75009",
"city": "Paris",
"country": "FR"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"shareholding_type": "physical",
"legal_entities": [
{
"legal_name": "Olinda",
"legal_number": 123456789,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_country": "FR",
"capital_amount": "1023.43"
}
]
}
],
"id": "a584b060-8c96-488d-8bbb-74f0d3d2803c",
"legal_flow": "company_creation",
"flow": {
"type": "seamless",
"breakdown": [
{
"code": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>"
}
}
]
},
"status": "pending",
"redirection_link": "https://xyz.qonto.com/registrations/ID",
"partner_redirect_url": "https://example.com/users/123456/dashboard",
"created_at": "2021-08-17T12:31:32.689Z",
"updated_at": "2021-08-17T14:00:00.689Z"
}
}Create a registration
Creates a single registration for the authenticated partner i.e. triggers a workflow to guide the user through the necessary steps to register its organization with Qonto. The response provides a registration ID for tracking the registration progress.
This endpoint supports both existing company registration and new company creation, determined by the legal_flow attribute.
For German companies and freelancers, specific schemas are used with adapted requirements.
curl --request POST \
--url https://thirdparty-sandbox.staging.qonto.co/register/registrations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Qonto-Partner-Id: <api-key>' \
--data '
{
"legal_flow": "existing_company",
"locale": "en",
"partner_redirect_url": "https://example.com/users/123456/dashboard",
"partner_user": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe"
},
"organization": {
"legal_number": "123232323"
}
}
'{
"registration": {
"locale": "fr",
"partner_user": {
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]"
},
"organization": {
"legal_name": "Olinda",
"legal_form": "SAS",
"address": {
"line_1": "Rue La Fayette 20B",
"postal_code": "75009",
"city": "Paris",
"country": "FR",
"line_2": "Room 5"
},
"total_capital_amount": {
"value": "1023.43",
"currency": "EUR"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_type": "company",
"legal_number": "<string>",
"legal_sector": "K.64.11",
"legal_registration_date": "2023-12-25",
"legal_vat_number": "<string>"
},
"stakeholders": [
{
"capital_amount": {
"value": "1023.43",
"currency": "EUR"
},
"is_owner": true,
"first_name": "Leeroy",
"last_name": "Jenkins",
"email": "[email protected]",
"gender": "male",
"phone_number": "0033123456789",
"nationality": "FR",
"birth_date": "2021-08-17T12:31:32.689Z",
"birth_address": {
"postal_code": "75009",
"city": "Paris",
"country": "FR"
},
"residence_address": {
"line_1": "Rue La Fayette 20B",
"postal_code": "75009",
"city": "Paris",
"country": "FR"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"shareholding_type": "physical",
"legal_entities": [
{
"legal_name": "Olinda",
"legal_number": 123456789,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_country": "FR",
"capital_amount": "1023.43"
}
]
}
],
"id": "a584b060-8c96-488d-8bbb-74f0d3d2803c",
"legal_flow": "company_creation",
"flow": {
"type": "seamless",
"breakdown": [
{
"code": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>"
}
}
]
},
"status": "pending",
"redirection_link": "https://xyz.qonto.com/registrations/ID",
"partner_redirect_url": "https://example.com/users/123456/dashboard",
"created_at": "2021-08-17T12:31:32.689Z",
"updated_at": "2021-08-17T14:00:00.689Z"
}
}Authorizations
Bearer authorization header: Bearer <token>.
To get your <token>, please sign up to the Developer Portal.
API Key authorization header: Qonto-Partner-Id: <partner_id>.
To get your <partner_id> please, sign up to the Developer Portal.
Headers
Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.
Body
- Request payload for Existing Company flow
- Request payload for Company Creation flow
- Request payload for German Existing Company flow
- Request payload for German Company Creation flow
Only a subset is supported from IETF Language Tags
en, fr, it, de, es, pt "fr"
Describes the user that owns the flow on the partner side.
Show child attributes
Show child attributes
"John"
"Doe"
It should match this regex /\A[\x21-\x39\x41-\x7E]+@[\x21-\x39\x41-\x7E]+\.[\x21-\x39\x41-\x7E]+\z/
Identifies the type of registration process:
company_creation: Initiates a new company registration.existing_company: Registers an existing company.
existing_company The URL where the user will be redirected after the registration process is completed. If not provided, then the user will be redirected to Qonto's application.
Note: this parameter is allowed only for embed applications.
"https://example.com/users/123456/dashboard"
Show child attributes
Show child attributes
If true, the oauth authorization_code will be generated after contract is signed. All other fields are mandatory if this is true.
true
The client_id used to generate the oauth authorization_code
"52ba9631-de19-4e8a-a47f-ba24e2bebc9e"
The scopes to be used to generate the OAuth authorization_code. Same as the authorization code retrieval, you should pass them in a single string, with a space as a separator.
"organization.read offline_access attachment.write internal_transfer.write"
It is a security parameters to protect against forgery attacks and/or to keep the session state between the request and the callback.
You need to pass a value that is unique to the user. At the end of the authentication process, you should compare the received state with the one you provided to make sure they are equals.
8The redirect_uri used to generate the oauth authorization_code. Should be one allowed by the client_id.
This URL will be called by Qonto to send the authorization_code and the state parameter, as described in the oauth flow.
In addition to these parameters, the registration_id will be added to the query string.
Please note that this will be a server to server call: there will be no Cookies sent with this request. If you need to retrieve your session, please use the state field.
"https://example.com/oauth/callback"
Response
Returns the registration created.
Show child attributes
Show child attributes
Only a subset is supported from IETF Language Tags
en, fr, it, de, es, pt "fr"
Describes the user that owns the flow on the partner side.
Show child attributes
Show child attributes
"John"
"Doe"
It should match this regex /\A[\x21-\x39\x41-\x7E]+@[\x21-\x39\x41-\x7E]+\.[\x21-\x39\x41-\x7E]+\z/
Show child attributes
Show child attributes
"Olinda"
Legal form can be one of the following ones:
For FR:
- SAS - Société par action simplifiée
- SASU - Société par action simplifiée unipersonnelle
- SARL - Société à responsabilité limitée
- EURL - Entreprise unipersonnelle à responsabilité limitée
- SELARL - Société d'exercice libéral à responsabilité limitée
- SNC - Société en nom collectif
- SCI - Société civile immobilière
- Autre société civile
SAS, SASU, SARL, EURL, SELARL, SNC, SCI, Autre société civile "SAS"
Show child attributes
Show child attributes
"Rue La Fayette 20B"
"75009"
"Paris"
ISO country code
Supported countries for registration.legal_flow: company_creation:
- FR
Supported countries for registration.legal_flow: existing_company:
- DE
"FR"
"Room 5"
Organization type
freelancer, company "company"
Registration number of the organization
Foundation date of organization
VAT identification number, used only when registration.legal_flow == 'existing_company'
When provided and legal country is DE it should match this regex /\ADE\d{9}\z/
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The capital amount for this stakeholder. A stakeholder will be defined as a Ultimate Beneficial Owner for contributions over 25% of the total contibution amount. Note that this value cannot be null. It can be 0 if this stakeholder is not a physical shareholder, but a legal representative only. They must have legal entities in this case.
"1023.43"
EUR "EUR"
Mark the stakeholder as the owner of the Qonto Account. An organization can have exactly one owner. The Account owner is the sole person responsible for opening the account and can close it at any time
true
"Leeroy"
"Jenkins"
The stakeholder's email. Should be present for all. It should match this regex /\A[\x21-\x39\x41-\x7E]+@[\x21-\x39\x41-\x7E]+\.[\x21-\x39\x41-\x7E]+\z/
male, female, other "male"
The stakeholder's phone number. Should be present for owners.
The supported format is: exit code + country code + national subscriber number.
The exit code in the majority of countries is "00", you can use also "+".
The phone number can include a whitespace after the country code.
Examples:
+33 123456789
0033 123456789
+33123456789
0033123456789
"0033123456789"
ISO country code
"FR"
The stakeholder's birth date.
When present it should be between today and 150 years ago
"2021-08-17T12:31:32.689Z"
Show child attributes
Show child attributes
required to have a value only if country=FR
"75009"
"Paris"
ISO country code
"FR"
Show child attributes
Show child attributes
"Rue La Fayette 20B"
"75009"
"Paris"
ISO country code
"FR"
Use physical only if the stakeholder is a physical shareholder. Use null or don't provide this field if the stakeholder is not a physical shareholder, but a legal representative of one or more legal entities.
physical "physical"
Show child attributes
Show child attributes
Legal name of this legal entity
"Olinda"
SIRET number of this legal entity
123456789
ISO country code
"FR"
The capital amount for this legal entity as legal shareholder. Note that this value cannot be 0.
"1023.43"
"a584b060-8c96-488d-8bbb-74f0d3d2803c"
Identifies the type of registration process:
company_creation: Initiates a new company registration.existing_company: Registers an existing company.
company_creation, existing_company Show child attributes
Show child attributes
Describe the flow this registration is eligible into.
Available statuses:
- manual: User will have to supply all information
- seamless: User won't be asked whatever has been provided from the registration partner
manual, seamless "seamless"
Whether this registration process if finished or not. This will be "pending" by default.
created, pending, user_started, price_plan_selected, contract_signed, submitted, capital_deposit_activated, capital_deposit_request_signed, capital_deposit_certificate_signed, completed "pending"
A unique link associated to the specific user, where they can start their journey to create an account at Qonto.
"https://xyz.qonto.com/registrations/ID"
The URL where the user will be redirected after the registration process is completed. If not provided, then the user will be redirected to Qonto's application.
Note: this parameter is allowed only for embed applications.
"https://example.com/users/123456/dashboard"
"2021-08-17T12:31:32.689Z"
"2021-08-17T14:00:00.689Z"
Was this page helpful?