--- title: "POST /borrowers" method: POST path: "/borrowers" tags: ["Onboarding"] --- # POST /borrowers `POST /borrowers`

Enroll a new borrower on Defacto.

This API will create a borrower and a credit line for this borrower. More information in the behavior section below.

Timeout: 30 seconds (status code will be 504 in such a case)


Required data

Borrower must be a commercial company -> eg. in France needs to be registered at an RCS.

If the borrower repays by direct debit, the following information are mandatory:

We strongly recommend that you fill up all the information when you can, even on the sandbox. For French borrowers, we manage to pull most of the director information automatically, however for other countries, this might not be the case. For the borrowers that Defacto is not able to fetch the mandatory data, you need to provide them to ensure borrower creation. Otherwise the API will return a 400 error and list the values that it could not obtain.

Behavior

This API endpoint creates a borrower in our system, configures our system to get the repayment of the loan, evaluates the maximum amount of money we can lend to this company and creates a credit line for this borrower. After the credit line is created for this borrower, you can get it with GET /credit-lines?borrower=.
Synchronous and asynchronous behaviors are offered.

Synchronous behavior:


Asynchronous behavior (default one):

🚧

Careful if you subscribe to the CreditLine.CREATED webhook!

If you subscribe to the webhook, please note that there is an inconsistency in the API at the moment. The webhook sends a borrower_id that does not correspond to the borrower id that you received with this endpoint (it's rather a business_id in our DB, that you cannot fetch).

So at the moment we recommend you to GET /credit-lines?borrower= for all borrowers waiting for a credit line when you receive the webhook event.

## Request body - APIPostBorrower - `account_number` string, nullable β€” The account identifier. Only IBANs are supported at the moment. - `address` BusinessAddress - `address_line_1` string, required - `address_line_2` string, nullable - `city` string, required - `country` string, required - `postal_code` string, required - `state` string, nullable - `directors` APICreateDirector[], nullable - `address` CreateAddress - `address_line_1` string, nullable - `address_line_2` string, nullable - `city` string, nullable - `country` string, nullable - `postal_code` string, nullable - `state` string, nullable - `birth_date` string, date, nullable β€” Birth date of the person. (YYYY-MM-DD) - `birth_place` BirthPlace - `city` string, nullable β€” City where the person was born. - `country` string, nullable β€” Country where the person was born. Must be a ISO 3166 alpha-3 country code (e.g. FRA). - `business_email` string, email, nullable - `business_phone_number` string, nullable β€” PhoneNumber - `entity_type` 'account' | 'account_detail_verification' | 'account_transaction' | 'bill' | 'borrower' | 'borrower_financial_product' | 'business' | 'business_exposure' | 'business_financial_product' | 'contract' | 'counterparty' | 'country' | 'credit_card' | 'credit_line' | 'data_request' | 'deposit' | 'due_interest' | 'eligibility_request' | 'enrollment' | 'entity_eligibility' | 'financial_product' | 'flag' | 'installment' | 'invoice' | 'loan' | 'loan_log' | 'loan_request' | 'mandate' | 'max_exposure_deployment' | 'onboarding' | 'onboarding_financial_product' | 'payment' | 'people' | 'rac' | 'raw_data' | 'recollection_document' | 'revenue_share' | 'sandbox_invoice' | 'underwriting_check' - `first_name` string, nullable β€” The first name of the person. - `id` unknown - `identifier` string, nullable β€” Legal identifier of the business, such as its SIRET or SIREN in France. Must not contain spaces. - `identifier_type` 'belgium_registration_number' | 'bsn' | 'cif' | 'hr_nummer' | 'kvk' | 'name' | 'nif' | 'siren' | 'siret' | 'steuernummer' | 'vat_number' | 'null', nullable β€” Type of legal business identifier of the business, such as the SIRET in France. - `last_name` string, nullable β€” The first name of the person. - `legal_name` string, nullable β€” Legal name of the business. - `nationality` string, nullable β€” Nationality of the person. Must be a ISO 3166 alpha-3 country code (e.g. FRA). - `role` 'DIRECTOR' | 'NON_DIRECTOR' - `siege_address` CreateAddress - `address_line_1` string, nullable - `address_line_2` string, nullable - `city` string, nullable - `country` string, nullable - `postal_code` string, nullable - `state` string, nullable - `title` string, nullable β€” Title of the person (e.g. M., Dr., etc.) - `identifier` string, required β€” Legal identifier of the business, such as its SIRET or SIREN in France. Must not contain spaces. - `identifier_type` 'belgium_registration_number' | 'bsn' | 'cif' | 'hr_nummer' | 'kvk' | 'nif' | 'siren' | 'siret' | 'steuernummer' | 'vat_number' | 'null', nullable β€” Type of legal business identifier of the business, such as the SIRET in France. - `legal_form` string, nullable β€” Legal form of the business. - `metadata` object, nullable β€” This object is yours, it enables you to add custom data. - `name` string, nullable β€” Legal name of the business. - `owner` APICreateOwner - `birth_date` string, date, nullable - `email` string, email, nullable - `first_name` string, required - `identity_documents` APICreateIdentityDocuments - `custom_identity_documents` APIIdentityDocument[], nullable - `description` string, nullable β€” An optional string that describes the document. - `document_binary_base64` string, required β€” A string that represents the document's binary content encoded in Base64. - `filename` string, required β€” The name of the file, including its extension. - `identity_document_back` APIIdentityDocument - `description` string, nullable β€” An optional string that describes the document. - `document_binary_base64` string, required β€” A string that represents the document's binary content encoded in Base64. - `filename` string, required β€” The name of the file, including its extension. - `identity_document_front` APIIdentityDocument - `description` string, nullable β€” An optional string that describes the document. - `document_binary_base64` string, required β€” A string that represents the document's binary content encoded in Base64. - `filename` string, required β€” The name of the file, including its extension. - `last_name` string, required - `phone_number` string, nullable β€” PhoneNumber - `preferred_language` string, nullable β€” Preferred language of the borrower in format ISO 639-1 (examples: [fr, en, es, de, nl]). - `signed_at` string, date-time, nullable β€” datetime of the borrower's signature. Usually time the borrower clicked on our T&Cs checkbox - `vat_number` string, nullable β€” VatNumber - `wait_for_ready` boolean β€” Wait for the borrower to be ready to request a first loan.Many actions have to run in the background (KYC, scoring, contract generation and so on).We recommend you to subscribe to the CreditLine.CREATED webhook in order to be notified in real time when the credit line is available. ## Response `201` Created --- [API](https://skmtc.net/getdefacto/apis/api-reference.md) Β· [All operations](https://skmtc.net/getdefacto/apis/api-reference/llms.txt) Β· [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getdefacto/api-reference/revisions/0a9c1f8784f2/schema)