# Clients onboarding

## Creates an individual client with the onboarding information

> Creates an individual client.\<br /> The onboarding information are submitted in the same request.\<br /> Client is created with the status \*\*ONBOARDING\_UNDER\_REVIEW\*\*.\<br /> The whole onboarding is a multiple step process: \<br />\
> &#x20; 1\. The onboarding information must be submitted,\
> &#x20; 2\. The information must be verified by Rialto's compliance team,\
> &#x20; 3\. The client must sign the terms and conditions.<br>

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"servers":[{"url":"https://api.rialtobridge.xyz/api/manager/v1","description":"Main (production) server for the Rialto Manager API"},{"url":"https://staging.api.rialtobridge.xyz/api/manager/v1","description":"Test (staging) server for the Rialto Manager API"},{"url":"http://localhost:3002/api/manager/v1","description":"Development server for the Rialto Manager API"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"RIALTO_API_KEY","in":"header"}},"requestBodies":{"IndividualOnboardingPayload":{"required":true,"description":"The payload to create an individual client or update its onboarding.","content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","format":"email","description":"The email of the individual."},"phone":{"type":"string","description":"The phone of the individual."},"address":{"type":"string","description":"The address of the individual."},"city":{"type":"string","description":"The city of the individual."},"postalCode":{"type":"string","description":"The postal code of the individual."},"countryCode":{"type":"string","description":"The country code of the individual.<br /> See the [list of supported country codes](https://docs.rialtobridge.xyz/concepts).\n"},"occupation":{"type":"string","description":"The occupation of the individual. <br /> See the [list of supported occupations](https://docs.rialtobridge.xyz/concepts).\n"},"occupationDescription":{"type":["string","null"],"description":"The occupation description of the individual if not in the list of occupations."},"companyName":{"type":"string","description":"The company name of the individual."},"jobBusinessSector":{"type":"string","description":"The job business sector of the individual.<br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"jobBusinessSectorDescription":{"type":["string","null"],"description":"The job business sector description of the individual if not in the list of business sectors."},"purposeOfOnboarding":{"type":"string","description":"The purpose of onboarding of the individual.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"idDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the ID Documentation of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of address of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of AML of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}}}},"sourceOfFunds":{"type":"object","properties":{"sourceOfFunds":{"type":"string","description":"The source of funds of the individual.<br /> See the [list of supported sources of funds](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDescription":{"type":["string","null"],"description":"The source of funds description of the individual if not in the list of sources of funds."},"annualRevenueRange":{"type":"string","description":"The annual revenue range of the individual.<br /> See the [list of supported annual revenue ranges](https://docs.rialtobridge.xyz/concepts).\n"},"globalWealthRange":{"type":"string","description":"The global wealth range of the individual.<br /> See the [list of supported global wealth ranges](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the source of funds of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfTaxResidencyDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of tax residency of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"taxNoticeDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the tax notice of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"supportingOccupationDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the occupation of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}}}},"bankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/CreateBankAccountPayload"}},"blockchainWallets":{"type":"array","items":{"$ref":"#/components/schemas/CreateBlockchainWalletPayload"}}}}}}}},"schemas":{"CreateBankAccountPayload":{"type":"object","properties":{"label":{"type":["string","null"],"description":"The label of the bank account."},"fiatCurrency":{"type":"string","description":"The fiat currency of the bank account. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat currencies."},"countryCode":{"type":"string","description":"The country code of the bank account."},"type":{"type":"string","description":"The type of the bank account. Possible values are:\n  - PERSONAL: The bank account is owned by the user,\n  - THIRD_PARTY: The bank account is owned by a third party, other than the user.\n","enum":["PERSONAL","THIRD_PARTY"]},"identifiers":{"$ref":"#/components/schemas/BankAccountIdentifiers"},"thirdPartyBankAccountOwnerName":{"type":["string","null"],"description":"The name of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerAddress":{"type":["string","null"],"description":"The address of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerCity":{"type":["string","null"],"description":"The city of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerPostalCode":{"type":["string","null"],"description":"The postal code of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerCountryCode":{"type":["string","null"],"description":"The country code of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerDocuments":{"type":["array","null"],"description":"The filenames of the documents of the owner of the bank account.<br /> The documents must be uploaded before creating the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n","items":{"type":"string"}}}},"BankAccountIdentifiers":{"type":"object","description":"The identifiers of the bank account.","oneOf":[{"type":"object","properties":{"format":{"type":"string","enum":["IBAN"]},"iban":{"type":"string","description":"The IBAN of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"swift":{"type":"string","description":"The SWIFT of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT_MX"]},"clabe":{"type":"string","description":"The CLABE of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["ROUTING_NUMBER"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"routingNumber":{"type":"string","description":"The routing number of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SORT_CODE"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"sortCode":{"type":"string","description":"The sort code of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["IN_INR"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"ifsc":{"type":"string","description":"The IFSC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["AU"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"bsb":{"type":"string","description":"The BSB of the bank account."}}}]},"CreateBlockchainWalletPayload":{"type":"object","properties":{"label":{"type":["string","null"],"description":"The label of the blockchain wallet."},"blockchainNetwork":{"type":"string","description":"The blockchain network of the wallet. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchains."},"address":{"type":"string","description":"The address of the blockchain wallet."}}},"Client":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the client."},"status":{"type":"string","enum":["ONBOARDING_IN_PROGRESS","ONBOARDING_UNDER_REVIEW","RESUBMISSION_REQUIRED","WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE","VERIFIED","DELETED"],"description":"The status of the client. <br />\n  - ONBOARDING_IN_PROGRESS: The client is in the onboarding process. <br />\n  - ONBOARDING_UNDER_REVIEW: The client is under review. <br />\n  - RESUBMISSION_REQUIRED: Rialto's compliance team has required more information for onboarding, information must be resubmitted.<br />\n  - WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE: The client is waiting for the terms and conditions signature. <br />\n  - VERIFIED: The client is verified,\n  - DELETED: The client is deleted.\n"},"clientType":{"type":"string","enum":["INDIVIDUAL","ENTITY"],"description":"The type of the client. <br />\n  - INDIVIDUAL: The client is an individual client. <br />\n  - ENTITY: The client is an entity client.\n"},"company":{"type":["object","null"],"description":"The company information of the client.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**.\n","properties":{"name":{"type":"string","description":"The name of the company."},"registrationNumber":{"type":["string","null"],"description":"The registration number of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddress":{"type":["string","null"],"description":"The registered address of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressCity":{"type":["string","null"],"description":"The registered address city of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressPostalCode":{"type":["string","null"],"description":"The registered address postal code of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressCountryCode":{"type":["string","null"],"description":"The registered address country code of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported country codes](https://docs.rialtobridge.xyz/concepts).\n"},"placeOfEffectiveBusiness":{"type":["string","null"],"description":"The place of effective business of the company.<br /> Can be null during the onboarding process.\n"},"businessSector":{"type":["string","null"],"description":"The business sector of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"businessSectorDescription":{"type":["string","null"],"description":"The business sector description of the company if not in the list of business sectors."},"turnover":{"type":["string","null"],"description":"The turnover of the company.<br /> Can be null during the onboarding process.\n"},"turnoverDocuments":{"type":["array"],"description":"The keys of the documents related to the turnover of the company.<br /> Each key can be used in order to download the document.\n","items":{"type":"string"}},"lastTaxNoticeDocuments":{"type":["array"],"description":"The keys of the documents related to the last tax notice of the company.<br /> Each key can be used in order to download the document.\n","items":{"type":"string"}},"purposeOfOnboarding":{"type":["string","null"],"description":"The purpose of onboarding of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of incorporation of the company.<br /> Each key can be used in order to download the document.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the memorandum of association of the company.<br /> Each key can be used in order to download the document.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the registry of directors and shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"structureChartOfShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the structure chart of shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the company.<br /> Each key can be used in order to download the document.\n"}}}},"companyRepresentatives":{"type":["array","null"],"description":"The entity representatives of the client.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**.\n","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the representative."},"firstName":{"type":"string","description":"The first name of the representative."},"lastName":{"type":"string","description":"The last name of the representative."},"email":{"type":"string","format":"email","description":"The email of the representative."},"phone":{"type":["string","null"],"description":"The phone number of the representative.<br /> Can be null during the onboarding process.\n"},"jobTitle":{"type":["string","null"],"description":"The job title of the representative.<br /> Can be null during the onboarding process.\n"},"supportingDocuments":{"type":"array","items":{"type":"string"},"description":"The keys of the documents related to the representative.<br /> Each key can be used in order to download the document.\n"},"role":{"type":"string","enum":["AUTHORIZED_SIGNATORY","OPERATOR"],"description":"The role of the representative.<br />\n  - AUTHORIZED_SIGNATORY: The representative is an authorized signatory of the company,\n  - OPERATOR: The representative is an operator of the company.\n"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the representative."},"updatedAt":{"type":"string","format":"date-time","description":"The last update date of the representative."},"deletedAt":{"type":["string","null"],"format":"date-time","description":"The deletion date of the representative."}}}},"companyDirectorsAndUbos":{"type":["object","null"],"description":"The directors and UBOs of the company.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**. Null for individual clients.\n","properties":{"directors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}}},"ubos":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"NATURAL"},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"LEGAL"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of incorporation of the company.<br /> Each key can be used in order to download the document.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the memorandum of association of the company.<br /> Each key can be used in order to download the document.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the registry of directors and shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}}],"discriminator":{"propertyName":"typeOfPerson"}}}}},"individualProfile":{"type":["object","null"],"description":"The individual profile of the client.<br /> This field is only present for individual clients, i.e. when the `clientType` is **INDIVIDUAL**.\n","properties":{"firstName":{"type":"string","description":"The first name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":["string","null"],"format":"email","description":"The email of the individual.<br /> Can be null during the onboarding process.\n"},"phone":{"type":["string","null"],"description":"The phone of the individual.<br /> Can be null during the onboarding process.\n"},"address":{"type":["string","null"],"description":"The address of the individual.<br /> Can be null during the onboarding process.\n"},"city":{"type":["string","null"],"description":"The city of the individual.<br /> Can be null during the onboarding process.\n"},"postalCode":{"type":["string","null"],"description":"The postal code of the individual.<br /> Can be null during the onboarding process.\n"},"countryCode":{"type":["string","null"],"description":"The country code of the individual.<br /> Can be null during the onboarding process.\n"},"occupation":{"type":["string","null"],"description":"The occupation of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported occupations](https://docs.rialtobridge.xyz/concepts).\n"},"occupationDescription":{"type":["string","null"],"description":"The occupation description of the individual if not in the list of occupations."},"companyName":{"type":["string","null"],"description":"The company name of the individual.<br /> Can be null during the onboarding process.\n"},"jobBusinessSector":{"type":["string","null"],"description":"The job business sector of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"jobBusinessSectorDescription":{"type":["string","null"],"description":"The job business sector description of the individual if not in the list of business sectors."},"purposeOfOnboarding":{"type":["string","null"],"description":"The purpose of onboarding of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID Documentation of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the individual.<br /> Each key can be used in order to download the document.\n"}}}},"individualSourceOfFunds":{"type":["object","null"],"description":"The source of funds of the individual.<br /> This field is only present for individual clients, i.e. when the `clientType` is **INDIVIDUAL**.\n","properties":{"sourceOfFunds":{"type":["string","null"],"description":"The source of funds of the user.<br /> Can be null during the onboarding process.<br /> See the [list of supported sources of funds](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDescription":{"type":["string","null"],"description":"The source of funds description of the user if not in the list of sources of funds."},"annualRevenueRange":{"type":["string","null"],"description":"The annual revenue range of the user.<br /> Can be null during the onboarding process.<br /> See the [list of supported annual revenue ranges](https://docs.rialtobridge.xyz/concepts).\n"},"globalWealthRange":{"type":["string","null"],"description":"The global wealth range of the user.<br /> Can be null during the onboarding process. <br /> See the [list of supported global wealth ranges](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the source of funds of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfTaxResidencyDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of tax residency of the individual.<br /> Each key can be used in order to download the document.\n"}},"taxNoticeDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the tax notice of the individual.<br /> Each key can be used in order to download the document.\n"}},"supportingOccupationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the occupation of the individual.<br /> Each key can be used in order to download the document.\n"}}}},"onboardingResubmissionReason":{"type":["string","null"],"description":"The reason why the onboarding information must be resubmitted.<br /> This field is only present when the client is in the status **RESUBMISSION_REQUIRED**.\n"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the client."},"updatedAt":{"type":"string","format":"date-time","description":"The last update date of the client."},"deletedAt":{"type":["string","null"],"format":"date-time","description":"The deletion date of the client."}}}}},"paths":{"/clients/individuals":{"post":{"summary":"Creates an individual client with the onboarding information","description":"Creates an individual client.<br /> The onboarding information are submitted in the same request.<br /> Client is created with the status **ONBOARDING_UNDER_REVIEW**.<br /> The whole onboarding is a multiple step process: <br />\n  1. The onboarding information must be submitted,\n  2. The information must be verified by Rialto's compliance team,\n  3. The client must sign the terms and conditions.\n","operationId":"createIndividualClient","tags":["Clients onboarding"],"requestBody":{"$ref":"#/components/requestBodies/IndividualOnboardingPayload"},"responses":{"201":{"description":"Client created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","description":"The reason why the request is invalid."},"parameterErrors":{"type":["object","null"],"description":"The errors related to the parameters of the request.<br /> The object is null if there is no error related to the parameters.\n"}}}}}},"401":{"description":"Invalid API key"},"500":{"description":"An unexpected error occurred."}}}}}}
```

## Re-submits the onboarding information of an individual client.

> Re-submits the onboarding information of an individual client.\<br /> All the previously submitted onboarding informations are replaced.\<br /> The client must be in the status \*\*RESUBMISSION\_REQUIRED\*\*.\<br /> The client is set to the status \*\*ONBOARDING\_UNDER\_REVIEW\*\*.\<br /> The onboarding information is verified by Rialto's compliance team.<br>

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"servers":[{"url":"https://api.rialtobridge.xyz/api/manager/v1","description":"Main (production) server for the Rialto Manager API"},{"url":"https://staging.api.rialtobridge.xyz/api/manager/v1","description":"Test (staging) server for the Rialto Manager API"},{"url":"http://localhost:3002/api/manager/v1","description":"Development server for the Rialto Manager API"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"RIALTO_API_KEY","in":"header"}},"requestBodies":{"IndividualOnboardingPayload":{"required":true,"description":"The payload to create an individual client or update its onboarding.","content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","format":"email","description":"The email of the individual."},"phone":{"type":"string","description":"The phone of the individual."},"address":{"type":"string","description":"The address of the individual."},"city":{"type":"string","description":"The city of the individual."},"postalCode":{"type":"string","description":"The postal code of the individual."},"countryCode":{"type":"string","description":"The country code of the individual.<br /> See the [list of supported country codes](https://docs.rialtobridge.xyz/concepts).\n"},"occupation":{"type":"string","description":"The occupation of the individual. <br /> See the [list of supported occupations](https://docs.rialtobridge.xyz/concepts).\n"},"occupationDescription":{"type":["string","null"],"description":"The occupation description of the individual if not in the list of occupations."},"companyName":{"type":"string","description":"The company name of the individual."},"jobBusinessSector":{"type":"string","description":"The job business sector of the individual.<br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"jobBusinessSectorDescription":{"type":["string","null"],"description":"The job business sector description of the individual if not in the list of business sectors."},"purposeOfOnboarding":{"type":"string","description":"The purpose of onboarding of the individual.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"idDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the ID Documentation of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of address of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of AML of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}}}},"sourceOfFunds":{"type":"object","properties":{"sourceOfFunds":{"type":"string","description":"The source of funds of the individual.<br /> See the [list of supported sources of funds](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDescription":{"type":["string","null"],"description":"The source of funds description of the individual if not in the list of sources of funds."},"annualRevenueRange":{"type":"string","description":"The annual revenue range of the individual.<br /> See the [list of supported annual revenue ranges](https://docs.rialtobridge.xyz/concepts).\n"},"globalWealthRange":{"type":"string","description":"The global wealth range of the individual.<br /> See the [list of supported global wealth ranges](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the source of funds of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfTaxResidencyDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of tax residency of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"taxNoticeDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the tax notice of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"supportingOccupationDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the occupation of the individual.<br /> The documents must be uploaded before submitting the onboarding.\n"}}}},"bankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/CreateBankAccountPayload"}},"blockchainWallets":{"type":"array","items":{"$ref":"#/components/schemas/CreateBlockchainWalletPayload"}}}}}}}},"schemas":{"CreateBankAccountPayload":{"type":"object","properties":{"label":{"type":["string","null"],"description":"The label of the bank account."},"fiatCurrency":{"type":"string","description":"The fiat currency of the bank account. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat currencies."},"countryCode":{"type":"string","description":"The country code of the bank account."},"type":{"type":"string","description":"The type of the bank account. Possible values are:\n  - PERSONAL: The bank account is owned by the user,\n  - THIRD_PARTY: The bank account is owned by a third party, other than the user.\n","enum":["PERSONAL","THIRD_PARTY"]},"identifiers":{"$ref":"#/components/schemas/BankAccountIdentifiers"},"thirdPartyBankAccountOwnerName":{"type":["string","null"],"description":"The name of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerAddress":{"type":["string","null"],"description":"The address of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerCity":{"type":["string","null"],"description":"The city of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerPostalCode":{"type":["string","null"],"description":"The postal code of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerCountryCode":{"type":["string","null"],"description":"The country code of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerDocuments":{"type":["array","null"],"description":"The filenames of the documents of the owner of the bank account.<br /> The documents must be uploaded before creating the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n","items":{"type":"string"}}}},"BankAccountIdentifiers":{"type":"object","description":"The identifiers of the bank account.","oneOf":[{"type":"object","properties":{"format":{"type":"string","enum":["IBAN"]},"iban":{"type":"string","description":"The IBAN of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"swift":{"type":"string","description":"The SWIFT of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT_MX"]},"clabe":{"type":"string","description":"The CLABE of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["ROUTING_NUMBER"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"routingNumber":{"type":"string","description":"The routing number of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SORT_CODE"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"sortCode":{"type":"string","description":"The sort code of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["IN_INR"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"ifsc":{"type":"string","description":"The IFSC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["AU"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"bsb":{"type":"string","description":"The BSB of the bank account."}}}]},"CreateBlockchainWalletPayload":{"type":"object","properties":{"label":{"type":["string","null"],"description":"The label of the blockchain wallet."},"blockchainNetwork":{"type":"string","description":"The blockchain network of the wallet. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchains."},"address":{"type":"string","description":"The address of the blockchain wallet."}}},"Client":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the client."},"status":{"type":"string","enum":["ONBOARDING_IN_PROGRESS","ONBOARDING_UNDER_REVIEW","RESUBMISSION_REQUIRED","WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE","VERIFIED","DELETED"],"description":"The status of the client. <br />\n  - ONBOARDING_IN_PROGRESS: The client is in the onboarding process. <br />\n  - ONBOARDING_UNDER_REVIEW: The client is under review. <br />\n  - RESUBMISSION_REQUIRED: Rialto's compliance team has required more information for onboarding, information must be resubmitted.<br />\n  - WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE: The client is waiting for the terms and conditions signature. <br />\n  - VERIFIED: The client is verified,\n  - DELETED: The client is deleted.\n"},"clientType":{"type":"string","enum":["INDIVIDUAL","ENTITY"],"description":"The type of the client. <br />\n  - INDIVIDUAL: The client is an individual client. <br />\n  - ENTITY: The client is an entity client.\n"},"company":{"type":["object","null"],"description":"The company information of the client.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**.\n","properties":{"name":{"type":"string","description":"The name of the company."},"registrationNumber":{"type":["string","null"],"description":"The registration number of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddress":{"type":["string","null"],"description":"The registered address of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressCity":{"type":["string","null"],"description":"The registered address city of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressPostalCode":{"type":["string","null"],"description":"The registered address postal code of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressCountryCode":{"type":["string","null"],"description":"The registered address country code of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported country codes](https://docs.rialtobridge.xyz/concepts).\n"},"placeOfEffectiveBusiness":{"type":["string","null"],"description":"The place of effective business of the company.<br /> Can be null during the onboarding process.\n"},"businessSector":{"type":["string","null"],"description":"The business sector of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"businessSectorDescription":{"type":["string","null"],"description":"The business sector description of the company if not in the list of business sectors."},"turnover":{"type":["string","null"],"description":"The turnover of the company.<br /> Can be null during the onboarding process.\n"},"turnoverDocuments":{"type":["array"],"description":"The keys of the documents related to the turnover of the company.<br /> Each key can be used in order to download the document.\n","items":{"type":"string"}},"lastTaxNoticeDocuments":{"type":["array"],"description":"The keys of the documents related to the last tax notice of the company.<br /> Each key can be used in order to download the document.\n","items":{"type":"string"}},"purposeOfOnboarding":{"type":["string","null"],"description":"The purpose of onboarding of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of incorporation of the company.<br /> Each key can be used in order to download the document.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the memorandum of association of the company.<br /> Each key can be used in order to download the document.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the registry of directors and shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"structureChartOfShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the structure chart of shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the company.<br /> Each key can be used in order to download the document.\n"}}}},"companyRepresentatives":{"type":["array","null"],"description":"The entity representatives of the client.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**.\n","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the representative."},"firstName":{"type":"string","description":"The first name of the representative."},"lastName":{"type":"string","description":"The last name of the representative."},"email":{"type":"string","format":"email","description":"The email of the representative."},"phone":{"type":["string","null"],"description":"The phone number of the representative.<br /> Can be null during the onboarding process.\n"},"jobTitle":{"type":["string","null"],"description":"The job title of the representative.<br /> Can be null during the onboarding process.\n"},"supportingDocuments":{"type":"array","items":{"type":"string"},"description":"The keys of the documents related to the representative.<br /> Each key can be used in order to download the document.\n"},"role":{"type":"string","enum":["AUTHORIZED_SIGNATORY","OPERATOR"],"description":"The role of the representative.<br />\n  - AUTHORIZED_SIGNATORY: The representative is an authorized signatory of the company,\n  - OPERATOR: The representative is an operator of the company.\n"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the representative."},"updatedAt":{"type":"string","format":"date-time","description":"The last update date of the representative."},"deletedAt":{"type":["string","null"],"format":"date-time","description":"The deletion date of the representative."}}}},"companyDirectorsAndUbos":{"type":["object","null"],"description":"The directors and UBOs of the company.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**. Null for individual clients.\n","properties":{"directors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}}},"ubos":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"NATURAL"},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"LEGAL"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of incorporation of the company.<br /> Each key can be used in order to download the document.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the memorandum of association of the company.<br /> Each key can be used in order to download the document.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the registry of directors and shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}}],"discriminator":{"propertyName":"typeOfPerson"}}}}},"individualProfile":{"type":["object","null"],"description":"The individual profile of the client.<br /> This field is only present for individual clients, i.e. when the `clientType` is **INDIVIDUAL**.\n","properties":{"firstName":{"type":"string","description":"The first name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":["string","null"],"format":"email","description":"The email of the individual.<br /> Can be null during the onboarding process.\n"},"phone":{"type":["string","null"],"description":"The phone of the individual.<br /> Can be null during the onboarding process.\n"},"address":{"type":["string","null"],"description":"The address of the individual.<br /> Can be null during the onboarding process.\n"},"city":{"type":["string","null"],"description":"The city of the individual.<br /> Can be null during the onboarding process.\n"},"postalCode":{"type":["string","null"],"description":"The postal code of the individual.<br /> Can be null during the onboarding process.\n"},"countryCode":{"type":["string","null"],"description":"The country code of the individual.<br /> Can be null during the onboarding process.\n"},"occupation":{"type":["string","null"],"description":"The occupation of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported occupations](https://docs.rialtobridge.xyz/concepts).\n"},"occupationDescription":{"type":["string","null"],"description":"The occupation description of the individual if not in the list of occupations."},"companyName":{"type":["string","null"],"description":"The company name of the individual.<br /> Can be null during the onboarding process.\n"},"jobBusinessSector":{"type":["string","null"],"description":"The job business sector of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"jobBusinessSectorDescription":{"type":["string","null"],"description":"The job business sector description of the individual if not in the list of business sectors."},"purposeOfOnboarding":{"type":["string","null"],"description":"The purpose of onboarding of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID Documentation of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the individual.<br /> Each key can be used in order to download the document.\n"}}}},"individualSourceOfFunds":{"type":["object","null"],"description":"The source of funds of the individual.<br /> This field is only present for individual clients, i.e. when the `clientType` is **INDIVIDUAL**.\n","properties":{"sourceOfFunds":{"type":["string","null"],"description":"The source of funds of the user.<br /> Can be null during the onboarding process.<br /> See the [list of supported sources of funds](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDescription":{"type":["string","null"],"description":"The source of funds description of the user if not in the list of sources of funds."},"annualRevenueRange":{"type":["string","null"],"description":"The annual revenue range of the user.<br /> Can be null during the onboarding process.<br /> See the [list of supported annual revenue ranges](https://docs.rialtobridge.xyz/concepts).\n"},"globalWealthRange":{"type":["string","null"],"description":"The global wealth range of the user.<br /> Can be null during the onboarding process. <br /> See the [list of supported global wealth ranges](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the source of funds of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfTaxResidencyDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of tax residency of the individual.<br /> Each key can be used in order to download the document.\n"}},"taxNoticeDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the tax notice of the individual.<br /> Each key can be used in order to download the document.\n"}},"supportingOccupationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the occupation of the individual.<br /> Each key can be used in order to download the document.\n"}}}},"onboardingResubmissionReason":{"type":["string","null"],"description":"The reason why the onboarding information must be resubmitted.<br /> This field is only present when the client is in the status **RESUBMISSION_REQUIRED**.\n"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the client."},"updatedAt":{"type":"string","format":"date-time","description":"The last update date of the client."},"deletedAt":{"type":["string","null"],"format":"date-time","description":"The deletion date of the client."}}}}},"paths":{"/clients/individuals/{clientId}/onboarding":{"put":{"summary":"Re-submits the onboarding information of an individual client.","description":"Re-submits the onboarding information of an individual client.<br /> All the previously submitted onboarding informations are replaced.<br /> The client must be in the status **RESUBMISSION_REQUIRED**.<br /> The client is set to the status **ONBOARDING_UNDER_REVIEW**.<br /> The onboarding information is verified by Rialto's compliance team.\n","operationId":"submitIndividualOnboardingInformation","tags":["Clients onboarding"],"parameters":[{"name":"clientId","in":"path","required":true,"description":"The unique identifier of the client.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"$ref":"#/components/requestBodies/IndividualOnboardingPayload"},"responses":{"201":{"description":"Onboarding information submitted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}}},"400":{"description":"The request is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","description":"The reason why the request is invalid."},"parameterErrors":{"type":["object","null"],"description":"The errors related to the parameters of the request.<br /> The object is null if there is no error related to the parameters.\n"}}}}}},"401":{"description":"Invalid API key"},"404":{"description":"Client not found."}}}}}}
```

## Creates an entity client.

> Creates an entity client with the onboarding information.\<br /> The onboarding information are submitted in the same request.\<br /> Client is created with the status \*\*ONBOARDING\_UNDER\_REVIEW\*\*.\<br /> The whole onboarding is a multiple step process: \<br />\
> &#x20; 1\. The onboarding information must be submitted,\
> &#x20; 2\. The information must be verified by Rialto's compliance team,\
> &#x20; 3\. The client must sign the terms and conditions.<br>

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"servers":[{"url":"https://api.rialtobridge.xyz/api/manager/v1","description":"Main (production) server for the Rialto Manager API"},{"url":"https://staging.api.rialtobridge.xyz/api/manager/v1","description":"Test (staging) server for the Rialto Manager API"},{"url":"http://localhost:3002/api/manager/v1","description":"Development server for the Rialto Manager API"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"RIALTO_API_KEY","in":"header"}},"requestBodies":{"EntityOnboardingPayload":{"required":true,"description":"The payload to create an entity client or update its onboarding.","content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"object","properties":{"name":{"type":"string","description":"The name of the company."},"registrationNumber":{"type":"string","description":"The registration number of the company."},"registeredAddress":{"type":"string","description":"The registered address of the company."},"registeredAddressCity":{"type":"string","description":"The registered address city of the company."},"registeredAddressPostalCode":{"type":"string","description":"The registered address postal code of the company."},"registeredAddressCountryCode":{"type":"string","description":"The registered address country of the company."},"placeOfEffectiveBusiness":{"type":["string","null"],"description":"The place of effective business of the company, if different from the registered address."},"businessSector":{"type":"string","description":"The business sector of the company. <br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"businessSectorDescription":{"type":["string","null"],"description":"The business sector description of the company if not in the list of business sectors."},"turnover":{"type":"string","description":"The turnover of the company."},"turnoverDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the turnover of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"lastTaxNoticeDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the last tax notice of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"purposeOfOnboarding":{"type":"string","description":"The purpose of onboarding of the company.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of incorporation of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the memorandum of association of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the registry of directors and shareholders of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"structureChartOfShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the structure chart of shareholders of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of AML of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}}}},"representatives":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the representative."},"lastName":{"type":"string","description":"The last name of the representative."},"email":{"type":"string","format":"email","description":"The email of the representative."},"phone":{"type":"string","description":"The phone number of the representative."},"jobTitle":{"type":"string","description":"The job title of the representative."},"supportingDocuments":{"type":"array","items":{"type":"string"},"description":"The filenames of the documents related to the representative.<br /> The documents must be uploaded before submitting the onboarding.\n"},"role":{"type":"string","enum":["AUTHORIZED_SIGNATORY","OPERATOR"],"description":"The role of the representative.<br />\n  - AUTHORIZED_SIGNATORY: The representative is an authorized signatory of the company,\n  - OPERATOR: The representative is an operator of the company.\n"}}}},"companyDirectorsAndUbos":{"type":"object","properties":{"directors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"idDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the ID of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of address of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of AML of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}}}}},"ubos":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"NATURAL"},"idDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the ID of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of address of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of AML of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"LEGAL"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of incorporation of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the memorandum of association of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the registry of directors and shareholders of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of AML of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}}}}],"discriminator":{"propertyName":"typeOfPerson"}}}}},"bankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/CreateBankAccountPayload"}},"blockchainWallets":{"type":"array","items":{"$ref":"#/components/schemas/CreateBlockchainWalletPayload"}}}}}}}},"schemas":{"CreateBankAccountPayload":{"type":"object","properties":{"label":{"type":["string","null"],"description":"The label of the bank account."},"fiatCurrency":{"type":"string","description":"The fiat currency of the bank account. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat currencies."},"countryCode":{"type":"string","description":"The country code of the bank account."},"type":{"type":"string","description":"The type of the bank account. Possible values are:\n  - PERSONAL: The bank account is owned by the user,\n  - THIRD_PARTY: The bank account is owned by a third party, other than the user.\n","enum":["PERSONAL","THIRD_PARTY"]},"identifiers":{"$ref":"#/components/schemas/BankAccountIdentifiers"},"thirdPartyBankAccountOwnerName":{"type":["string","null"],"description":"The name of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerAddress":{"type":["string","null"],"description":"The address of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerCity":{"type":["string","null"],"description":"The city of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerPostalCode":{"type":["string","null"],"description":"The postal code of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerCountryCode":{"type":["string","null"],"description":"The country code of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerDocuments":{"type":["array","null"],"description":"The filenames of the documents of the owner of the bank account.<br /> The documents must be uploaded before creating the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n","items":{"type":"string"}}}},"BankAccountIdentifiers":{"type":"object","description":"The identifiers of the bank account.","oneOf":[{"type":"object","properties":{"format":{"type":"string","enum":["IBAN"]},"iban":{"type":"string","description":"The IBAN of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"swift":{"type":"string","description":"The SWIFT of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT_MX"]},"clabe":{"type":"string","description":"The CLABE of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["ROUTING_NUMBER"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"routingNumber":{"type":"string","description":"The routing number of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SORT_CODE"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"sortCode":{"type":"string","description":"The sort code of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["IN_INR"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"ifsc":{"type":"string","description":"The IFSC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["AU"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"bsb":{"type":"string","description":"The BSB of the bank account."}}}]},"CreateBlockchainWalletPayload":{"type":"object","properties":{"label":{"type":["string","null"],"description":"The label of the blockchain wallet."},"blockchainNetwork":{"type":"string","description":"The blockchain network of the wallet. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchains."},"address":{"type":"string","description":"The address of the blockchain wallet."}}},"Client":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the client."},"status":{"type":"string","enum":["ONBOARDING_IN_PROGRESS","ONBOARDING_UNDER_REVIEW","RESUBMISSION_REQUIRED","WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE","VERIFIED","DELETED"],"description":"The status of the client. <br />\n  - ONBOARDING_IN_PROGRESS: The client is in the onboarding process. <br />\n  - ONBOARDING_UNDER_REVIEW: The client is under review. <br />\n  - RESUBMISSION_REQUIRED: Rialto's compliance team has required more information for onboarding, information must be resubmitted.<br />\n  - WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE: The client is waiting for the terms and conditions signature. <br />\n  - VERIFIED: The client is verified,\n  - DELETED: The client is deleted.\n"},"clientType":{"type":"string","enum":["INDIVIDUAL","ENTITY"],"description":"The type of the client. <br />\n  - INDIVIDUAL: The client is an individual client. <br />\n  - ENTITY: The client is an entity client.\n"},"company":{"type":["object","null"],"description":"The company information of the client.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**.\n","properties":{"name":{"type":"string","description":"The name of the company."},"registrationNumber":{"type":["string","null"],"description":"The registration number of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddress":{"type":["string","null"],"description":"The registered address of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressCity":{"type":["string","null"],"description":"The registered address city of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressPostalCode":{"type":["string","null"],"description":"The registered address postal code of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressCountryCode":{"type":["string","null"],"description":"The registered address country code of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported country codes](https://docs.rialtobridge.xyz/concepts).\n"},"placeOfEffectiveBusiness":{"type":["string","null"],"description":"The place of effective business of the company.<br /> Can be null during the onboarding process.\n"},"businessSector":{"type":["string","null"],"description":"The business sector of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"businessSectorDescription":{"type":["string","null"],"description":"The business sector description of the company if not in the list of business sectors."},"turnover":{"type":["string","null"],"description":"The turnover of the company.<br /> Can be null during the onboarding process.\n"},"turnoverDocuments":{"type":["array"],"description":"The keys of the documents related to the turnover of the company.<br /> Each key can be used in order to download the document.\n","items":{"type":"string"}},"lastTaxNoticeDocuments":{"type":["array"],"description":"The keys of the documents related to the last tax notice of the company.<br /> Each key can be used in order to download the document.\n","items":{"type":"string"}},"purposeOfOnboarding":{"type":["string","null"],"description":"The purpose of onboarding of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of incorporation of the company.<br /> Each key can be used in order to download the document.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the memorandum of association of the company.<br /> Each key can be used in order to download the document.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the registry of directors and shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"structureChartOfShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the structure chart of shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the company.<br /> Each key can be used in order to download the document.\n"}}}},"companyRepresentatives":{"type":["array","null"],"description":"The entity representatives of the client.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**.\n","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the representative."},"firstName":{"type":"string","description":"The first name of the representative."},"lastName":{"type":"string","description":"The last name of the representative."},"email":{"type":"string","format":"email","description":"The email of the representative."},"phone":{"type":["string","null"],"description":"The phone number of the representative.<br /> Can be null during the onboarding process.\n"},"jobTitle":{"type":["string","null"],"description":"The job title of the representative.<br /> Can be null during the onboarding process.\n"},"supportingDocuments":{"type":"array","items":{"type":"string"},"description":"The keys of the documents related to the representative.<br /> Each key can be used in order to download the document.\n"},"role":{"type":"string","enum":["AUTHORIZED_SIGNATORY","OPERATOR"],"description":"The role of the representative.<br />\n  - AUTHORIZED_SIGNATORY: The representative is an authorized signatory of the company,\n  - OPERATOR: The representative is an operator of the company.\n"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the representative."},"updatedAt":{"type":"string","format":"date-time","description":"The last update date of the representative."},"deletedAt":{"type":["string","null"],"format":"date-time","description":"The deletion date of the representative."}}}},"companyDirectorsAndUbos":{"type":["object","null"],"description":"The directors and UBOs of the company.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**. Null for individual clients.\n","properties":{"directors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}}},"ubos":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"NATURAL"},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"LEGAL"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of incorporation of the company.<br /> Each key can be used in order to download the document.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the memorandum of association of the company.<br /> Each key can be used in order to download the document.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the registry of directors and shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}}],"discriminator":{"propertyName":"typeOfPerson"}}}}},"individualProfile":{"type":["object","null"],"description":"The individual profile of the client.<br /> This field is only present for individual clients, i.e. when the `clientType` is **INDIVIDUAL**.\n","properties":{"firstName":{"type":"string","description":"The first name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":["string","null"],"format":"email","description":"The email of the individual.<br /> Can be null during the onboarding process.\n"},"phone":{"type":["string","null"],"description":"The phone of the individual.<br /> Can be null during the onboarding process.\n"},"address":{"type":["string","null"],"description":"The address of the individual.<br /> Can be null during the onboarding process.\n"},"city":{"type":["string","null"],"description":"The city of the individual.<br /> Can be null during the onboarding process.\n"},"postalCode":{"type":["string","null"],"description":"The postal code of the individual.<br /> Can be null during the onboarding process.\n"},"countryCode":{"type":["string","null"],"description":"The country code of the individual.<br /> Can be null during the onboarding process.\n"},"occupation":{"type":["string","null"],"description":"The occupation of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported occupations](https://docs.rialtobridge.xyz/concepts).\n"},"occupationDescription":{"type":["string","null"],"description":"The occupation description of the individual if not in the list of occupations."},"companyName":{"type":["string","null"],"description":"The company name of the individual.<br /> Can be null during the onboarding process.\n"},"jobBusinessSector":{"type":["string","null"],"description":"The job business sector of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"jobBusinessSectorDescription":{"type":["string","null"],"description":"The job business sector description of the individual if not in the list of business sectors."},"purposeOfOnboarding":{"type":["string","null"],"description":"The purpose of onboarding of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID Documentation of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the individual.<br /> Each key can be used in order to download the document.\n"}}}},"individualSourceOfFunds":{"type":["object","null"],"description":"The source of funds of the individual.<br /> This field is only present for individual clients, i.e. when the `clientType` is **INDIVIDUAL**.\n","properties":{"sourceOfFunds":{"type":["string","null"],"description":"The source of funds of the user.<br /> Can be null during the onboarding process.<br /> See the [list of supported sources of funds](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDescription":{"type":["string","null"],"description":"The source of funds description of the user if not in the list of sources of funds."},"annualRevenueRange":{"type":["string","null"],"description":"The annual revenue range of the user.<br /> Can be null during the onboarding process.<br /> See the [list of supported annual revenue ranges](https://docs.rialtobridge.xyz/concepts).\n"},"globalWealthRange":{"type":["string","null"],"description":"The global wealth range of the user.<br /> Can be null during the onboarding process. <br /> See the [list of supported global wealth ranges](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the source of funds of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfTaxResidencyDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of tax residency of the individual.<br /> Each key can be used in order to download the document.\n"}},"taxNoticeDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the tax notice of the individual.<br /> Each key can be used in order to download the document.\n"}},"supportingOccupationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the occupation of the individual.<br /> Each key can be used in order to download the document.\n"}}}},"onboardingResubmissionReason":{"type":["string","null"],"description":"The reason why the onboarding information must be resubmitted.<br /> This field is only present when the client is in the status **RESUBMISSION_REQUIRED**.\n"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the client."},"updatedAt":{"type":"string","format":"date-time","description":"The last update date of the client."},"deletedAt":{"type":["string","null"],"format":"date-time","description":"The deletion date of the client."}}}}},"paths":{"/clients/entities":{"post":{"summary":"Creates an entity client.","description":"Creates an entity client with the onboarding information.<br /> The onboarding information are submitted in the same request.<br /> Client is created with the status **ONBOARDING_UNDER_REVIEW**.<br /> The whole onboarding is a multiple step process: <br />\n  1. The onboarding information must be submitted,\n  2. The information must be verified by Rialto's compliance team,\n  3. The client must sign the terms and conditions.\n","operationId":"createEntityClient","tags":["Clients onboarding"],"requestBody":{"$ref":"#/components/requestBodies/EntityOnboardingPayload"},"responses":{"201":{"description":"Client created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","description":"The reason why the request is invalid."},"parameterErrors":{"type":["object","null"],"description":"The errors related to the parameters of the request.<br /> The object is null if there is no error related to the parameters.\n"}}}}}},"401":{"description":"Invalid API key"},"500":{"description":"An unexpected error occurred."}}}}}}
```

## Re-submits the onboarding information of an entity client.

> Submits the onboarding information of an entity client.\<br /> All the previously submitted onboarding informations are replaced.\<br /> The client must be in the status \*\*RESUBMISSION\_REQUIRED\*\*.\<br /> The client is set to the status \*\*ONBOARDING\_UNDER\_REVIEW\*\*.\<br /> The onboarding information is verified by Rialto's compliance team.<br>

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"servers":[{"url":"https://api.rialtobridge.xyz/api/manager/v1","description":"Main (production) server for the Rialto Manager API"},{"url":"https://staging.api.rialtobridge.xyz/api/manager/v1","description":"Test (staging) server for the Rialto Manager API"},{"url":"http://localhost:3002/api/manager/v1","description":"Development server for the Rialto Manager API"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"RIALTO_API_KEY","in":"header"}},"requestBodies":{"EntityOnboardingPayload":{"required":true,"description":"The payload to create an entity client or update its onboarding.","content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"object","properties":{"name":{"type":"string","description":"The name of the company."},"registrationNumber":{"type":"string","description":"The registration number of the company."},"registeredAddress":{"type":"string","description":"The registered address of the company."},"registeredAddressCity":{"type":"string","description":"The registered address city of the company."},"registeredAddressPostalCode":{"type":"string","description":"The registered address postal code of the company."},"registeredAddressCountryCode":{"type":"string","description":"The registered address country of the company."},"placeOfEffectiveBusiness":{"type":["string","null"],"description":"The place of effective business of the company, if different from the registered address."},"businessSector":{"type":"string","description":"The business sector of the company. <br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"businessSectorDescription":{"type":["string","null"],"description":"The business sector description of the company if not in the list of business sectors."},"turnover":{"type":"string","description":"The turnover of the company."},"turnoverDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the turnover of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"lastTaxNoticeDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the last tax notice of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"purposeOfOnboarding":{"type":"string","description":"The purpose of onboarding of the company.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of incorporation of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the memorandum of association of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the registry of directors and shareholders of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"structureChartOfShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the structure chart of shareholders of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of AML of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}}}},"representatives":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the representative."},"lastName":{"type":"string","description":"The last name of the representative."},"email":{"type":"string","format":"email","description":"The email of the representative."},"phone":{"type":"string","description":"The phone number of the representative."},"jobTitle":{"type":"string","description":"The job title of the representative."},"supportingDocuments":{"type":"array","items":{"type":"string"},"description":"The filenames of the documents related to the representative.<br /> The documents must be uploaded before submitting the onboarding.\n"},"role":{"type":"string","enum":["AUTHORIZED_SIGNATORY","OPERATOR"],"description":"The role of the representative.<br />\n  - AUTHORIZED_SIGNATORY: The representative is an authorized signatory of the company,\n  - OPERATOR: The representative is an operator of the company.\n"}}}},"companyDirectorsAndUbos":{"type":"object","properties":{"directors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"idDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the ID of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of address of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of AML of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}}}}},"ubos":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"NATURAL"},"idDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the ID of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of address of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of AML of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"LEGAL"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of incorporation of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the memorandum of association of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the registry of directors and shareholders of the company.<br /> The documents must be uploaded before submitting the onboarding.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The filenames of the documents related to the proof of AML of the director.<br /> The documents must be uploaded before submitting the onboarding.\n"}}}}],"discriminator":{"propertyName":"typeOfPerson"}}}}},"bankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/CreateBankAccountPayload"}},"blockchainWallets":{"type":"array","items":{"$ref":"#/components/schemas/CreateBlockchainWalletPayload"}}}}}}}},"schemas":{"CreateBankAccountPayload":{"type":"object","properties":{"label":{"type":["string","null"],"description":"The label of the bank account."},"fiatCurrency":{"type":"string","description":"The fiat currency of the bank account. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat currencies."},"countryCode":{"type":"string","description":"The country code of the bank account."},"type":{"type":"string","description":"The type of the bank account. Possible values are:\n  - PERSONAL: The bank account is owned by the user,\n  - THIRD_PARTY: The bank account is owned by a third party, other than the user.\n","enum":["PERSONAL","THIRD_PARTY"]},"identifiers":{"$ref":"#/components/schemas/BankAccountIdentifiers"},"thirdPartyBankAccountOwnerName":{"type":["string","null"],"description":"The name of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerAddress":{"type":["string","null"],"description":"The address of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerCity":{"type":["string","null"],"description":"The city of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerPostalCode":{"type":["string","null"],"description":"The postal code of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerCountryCode":{"type":["string","null"],"description":"The country code of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerDocuments":{"type":["array","null"],"description":"The filenames of the documents of the owner of the bank account.<br /> The documents must be uploaded before creating the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n","items":{"type":"string"}}}},"BankAccountIdentifiers":{"type":"object","description":"The identifiers of the bank account.","oneOf":[{"type":"object","properties":{"format":{"type":"string","enum":["IBAN"]},"iban":{"type":"string","description":"The IBAN of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"swift":{"type":"string","description":"The SWIFT of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT_MX"]},"clabe":{"type":"string","description":"The CLABE of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["ROUTING_NUMBER"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"routingNumber":{"type":"string","description":"The routing number of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SORT_CODE"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"sortCode":{"type":"string","description":"The sort code of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["IN_INR"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"ifsc":{"type":"string","description":"The IFSC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["AU"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"bsb":{"type":"string","description":"The BSB of the bank account."}}}]},"CreateBlockchainWalletPayload":{"type":"object","properties":{"label":{"type":["string","null"],"description":"The label of the blockchain wallet."},"blockchainNetwork":{"type":"string","description":"The blockchain network of the wallet. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchains."},"address":{"type":"string","description":"The address of the blockchain wallet."}}},"Client":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the client."},"status":{"type":"string","enum":["ONBOARDING_IN_PROGRESS","ONBOARDING_UNDER_REVIEW","RESUBMISSION_REQUIRED","WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE","VERIFIED","DELETED"],"description":"The status of the client. <br />\n  - ONBOARDING_IN_PROGRESS: The client is in the onboarding process. <br />\n  - ONBOARDING_UNDER_REVIEW: The client is under review. <br />\n  - RESUBMISSION_REQUIRED: Rialto's compliance team has required more information for onboarding, information must be resubmitted.<br />\n  - WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE: The client is waiting for the terms and conditions signature. <br />\n  - VERIFIED: The client is verified,\n  - DELETED: The client is deleted.\n"},"clientType":{"type":"string","enum":["INDIVIDUAL","ENTITY"],"description":"The type of the client. <br />\n  - INDIVIDUAL: The client is an individual client. <br />\n  - ENTITY: The client is an entity client.\n"},"company":{"type":["object","null"],"description":"The company information of the client.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**.\n","properties":{"name":{"type":"string","description":"The name of the company."},"registrationNumber":{"type":["string","null"],"description":"The registration number of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddress":{"type":["string","null"],"description":"The registered address of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressCity":{"type":["string","null"],"description":"The registered address city of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressPostalCode":{"type":["string","null"],"description":"The registered address postal code of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressCountryCode":{"type":["string","null"],"description":"The registered address country code of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported country codes](https://docs.rialtobridge.xyz/concepts).\n"},"placeOfEffectiveBusiness":{"type":["string","null"],"description":"The place of effective business of the company.<br /> Can be null during the onboarding process.\n"},"businessSector":{"type":["string","null"],"description":"The business sector of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"businessSectorDescription":{"type":["string","null"],"description":"The business sector description of the company if not in the list of business sectors."},"turnover":{"type":["string","null"],"description":"The turnover of the company.<br /> Can be null during the onboarding process.\n"},"turnoverDocuments":{"type":["array"],"description":"The keys of the documents related to the turnover of the company.<br /> Each key can be used in order to download the document.\n","items":{"type":"string"}},"lastTaxNoticeDocuments":{"type":["array"],"description":"The keys of the documents related to the last tax notice of the company.<br /> Each key can be used in order to download the document.\n","items":{"type":"string"}},"purposeOfOnboarding":{"type":["string","null"],"description":"The purpose of onboarding of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of incorporation of the company.<br /> Each key can be used in order to download the document.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the memorandum of association of the company.<br /> Each key can be used in order to download the document.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the registry of directors and shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"structureChartOfShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the structure chart of shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the company.<br /> Each key can be used in order to download the document.\n"}}}},"companyRepresentatives":{"type":["array","null"],"description":"The entity representatives of the client.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**.\n","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the representative."},"firstName":{"type":"string","description":"The first name of the representative."},"lastName":{"type":"string","description":"The last name of the representative."},"email":{"type":"string","format":"email","description":"The email of the representative."},"phone":{"type":["string","null"],"description":"The phone number of the representative.<br /> Can be null during the onboarding process.\n"},"jobTitle":{"type":["string","null"],"description":"The job title of the representative.<br /> Can be null during the onboarding process.\n"},"supportingDocuments":{"type":"array","items":{"type":"string"},"description":"The keys of the documents related to the representative.<br /> Each key can be used in order to download the document.\n"},"role":{"type":"string","enum":["AUTHORIZED_SIGNATORY","OPERATOR"],"description":"The role of the representative.<br />\n  - AUTHORIZED_SIGNATORY: The representative is an authorized signatory of the company,\n  - OPERATOR: The representative is an operator of the company.\n"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the representative."},"updatedAt":{"type":"string","format":"date-time","description":"The last update date of the representative."},"deletedAt":{"type":["string","null"],"format":"date-time","description":"The deletion date of the representative."}}}},"companyDirectorsAndUbos":{"type":["object","null"],"description":"The directors and UBOs of the company.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**. Null for individual clients.\n","properties":{"directors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}}},"ubos":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"NATURAL"},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"LEGAL"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of incorporation of the company.<br /> Each key can be used in order to download the document.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the memorandum of association of the company.<br /> Each key can be used in order to download the document.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the registry of directors and shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}}],"discriminator":{"propertyName":"typeOfPerson"}}}}},"individualProfile":{"type":["object","null"],"description":"The individual profile of the client.<br /> This field is only present for individual clients, i.e. when the `clientType` is **INDIVIDUAL**.\n","properties":{"firstName":{"type":"string","description":"The first name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":["string","null"],"format":"email","description":"The email of the individual.<br /> Can be null during the onboarding process.\n"},"phone":{"type":["string","null"],"description":"The phone of the individual.<br /> Can be null during the onboarding process.\n"},"address":{"type":["string","null"],"description":"The address of the individual.<br /> Can be null during the onboarding process.\n"},"city":{"type":["string","null"],"description":"The city of the individual.<br /> Can be null during the onboarding process.\n"},"postalCode":{"type":["string","null"],"description":"The postal code of the individual.<br /> Can be null during the onboarding process.\n"},"countryCode":{"type":["string","null"],"description":"The country code of the individual.<br /> Can be null during the onboarding process.\n"},"occupation":{"type":["string","null"],"description":"The occupation of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported occupations](https://docs.rialtobridge.xyz/concepts).\n"},"occupationDescription":{"type":["string","null"],"description":"The occupation description of the individual if not in the list of occupations."},"companyName":{"type":["string","null"],"description":"The company name of the individual.<br /> Can be null during the onboarding process.\n"},"jobBusinessSector":{"type":["string","null"],"description":"The job business sector of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"jobBusinessSectorDescription":{"type":["string","null"],"description":"The job business sector description of the individual if not in the list of business sectors."},"purposeOfOnboarding":{"type":["string","null"],"description":"The purpose of onboarding of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID Documentation of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the individual.<br /> Each key can be used in order to download the document.\n"}}}},"individualSourceOfFunds":{"type":["object","null"],"description":"The source of funds of the individual.<br /> This field is only present for individual clients, i.e. when the `clientType` is **INDIVIDUAL**.\n","properties":{"sourceOfFunds":{"type":["string","null"],"description":"The source of funds of the user.<br /> Can be null during the onboarding process.<br /> See the [list of supported sources of funds](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDescription":{"type":["string","null"],"description":"The source of funds description of the user if not in the list of sources of funds."},"annualRevenueRange":{"type":["string","null"],"description":"The annual revenue range of the user.<br /> Can be null during the onboarding process.<br /> See the [list of supported annual revenue ranges](https://docs.rialtobridge.xyz/concepts).\n"},"globalWealthRange":{"type":["string","null"],"description":"The global wealth range of the user.<br /> Can be null during the onboarding process. <br /> See the [list of supported global wealth ranges](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the source of funds of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfTaxResidencyDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of tax residency of the individual.<br /> Each key can be used in order to download the document.\n"}},"taxNoticeDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the tax notice of the individual.<br /> Each key can be used in order to download the document.\n"}},"supportingOccupationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the occupation of the individual.<br /> Each key can be used in order to download the document.\n"}}}},"onboardingResubmissionReason":{"type":["string","null"],"description":"The reason why the onboarding information must be resubmitted.<br /> This field is only present when the client is in the status **RESUBMISSION_REQUIRED**.\n"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the client."},"updatedAt":{"type":"string","format":"date-time","description":"The last update date of the client."},"deletedAt":{"type":["string","null"],"format":"date-time","description":"The deletion date of the client."}}}}},"paths":{"/clients/entities/{clientId}/onboarding":{"put":{"summary":"Re-submits the onboarding information of an entity client.","description":"Submits the onboarding information of an entity client.<br /> All the previously submitted onboarding informations are replaced.<br /> The client must be in the status **RESUBMISSION_REQUIRED**.<br /> The client is set to the status **ONBOARDING_UNDER_REVIEW**.<br /> The onboarding information is verified by Rialto's compliance team.\n","operationId":"submitEntityOnboardingInformation","tags":["Clients onboarding"],"parameters":[{"name":"clientId","in":"path","required":true,"description":"The unique identifier of the client.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"$ref":"#/components/requestBodies/EntityOnboardingPayload"},"responses":{"201":{"description":"Onboarding information submitted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}}},"400":{"description":"The request is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","description":"The reason why the request is invalid."},"parameterErrors":{"type":["object","null"],"description":"The errors related to the parameters of the request.<br /> The object is null if there is no error related to the parameters.\n"}}}}}},"401":{"description":"Invalid API key"},"404":{"description":"Client not found."}}}}}}
```

## Generates a terms and conditions signature URL.

> Generates a terms and conditions signature URL for the client.\<br /> The client must be in the status \*\*WAITING\_FOR\_TERMS\_AND\_CONDITIONS\_SIGNATURE\*\*.\<br /> The URL is valid for 5 minutes and can only be used once.\<br /> A new URL can be generated if the previous one has expired.<br>

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"servers":[{"url":"https://api.rialtobridge.xyz/api/manager/v1","description":"Main (production) server for the Rialto Manager API"},{"url":"https://staging.api.rialtobridge.xyz/api/manager/v1","description":"Test (staging) server for the Rialto Manager API"},{"url":"http://localhost:3002/api/manager/v1","description":"Development server for the Rialto Manager API"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"RIALTO_API_KEY","in":"header"}}},"paths":{"/clients/{clientId}/terms-and-conditions-signature-url":{"post":{"summary":"Generates a terms and conditions signature URL.","description":"Generates a terms and conditions signature URL for the client.<br /> The client must be in the status **WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE**.<br /> The URL is valid for 5 minutes and can only be used once.<br /> A new URL can be generated if the previous one has expired.\n","operationId":"generateTermsAndConditionsSignatureLink","tags":["Clients onboarding"],"parameters":[{"name":"clientId","in":"path","required":true,"description":"The unique identifier of the client.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"returnUrl":{"type":"string","description":"The URL to redirect the user once the envelope has been signed."}},"required":["returnUrl"]}}}},"responses":{"201":{"description":"Terms and conditions signature link generated.","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The terms and conditions signature URL."},"expiresAt":{"type":"string","format":"date-time","description":"The expiration date of the URL."}}}}}},"400":{"description":"The request is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","description":"The reason why the request is invalid."},"parameterErrors":{"type":["object","null"],"description":"The errors related to the parameters of the request.<br /> The object is null if there is no error related to the parameters.\n"}}}}}},"401":{"description":"Invalid API key"},"404":{"description":"Client not found."},"500":{"description":"An unexpected error occurred."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.rialtobridge.xyz/manager-api-reference/clients-onboarding.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
