# Clients ## Returns the list of clients. > The clients are sorted by creation date, in descending order. The most recently created clients appear first.\
The clients are paginated, a maximum of 10 clients are returned per page.\
If there are more clients to fetch, the response includes a non null \`nextPageCursor\` field. \
The \`nextPageCursor\` can be injected in the \`cursor\` parameter to fetch the next page of clients.\
If the \`nextPageToken\` field is null, there are no more clients to fetch.
```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"}},"schemas":{"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.
\n - ONBOARDING_IN_PROGRESS: The client is in the onboarding process.
\n - ONBOARDING_UNDER_REVIEW: The client is under review.
\n - RESUBMISSION_REQUIRED: Rialto's compliance team has required more information for onboarding, information must be resubmitted.
\n - WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE: The client is waiting for the terms and conditions signature.
\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.
\n - INDIVIDUAL: The client is an individual client.
\n - ENTITY: The client is an entity client.\n"},"company":{"type":["object","null"],"description":"The company information of the client.
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.
Can be null during the onboarding process.\n"},"registeredAddress":{"type":["string","null"],"description":"The registered address of the company.
Can be null during the onboarding process.\n"},"registeredAddressCity":{"type":["string","null"],"description":"The registered address city of the company.
Can be null during the onboarding process.\n"},"registeredAddressPostalCode":{"type":["string","null"],"description":"The registered address postal code of the company.
Can be null during the onboarding process.\n"},"registeredAddressCountryCode":{"type":["string","null"],"description":"The registered address country code of the company.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.\n"},"businessSector":{"type":["string","null"],"description":"The business sector of the company.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.\n"},"turnoverDocuments":{"type":["array"],"description":"The keys of the documents related to the turnover of the company.
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.
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.
Can be null during the onboarding process.
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.
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.
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.
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.
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.
Each key can be used in order to download the document.\n"}}}},"companyRepresentatives":{"type":["array","null"],"description":"The entity representatives of the client.
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.
Can be null during the onboarding process.\n"},"jobTitle":{"type":["string","null"],"description":"The job title of the representative.
Can be null during the onboarding process.\n"},"supportingDocuments":{"type":"array","items":{"type":"string"},"description":"The keys of the documents related to the representative.
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.
\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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Can be null during the onboarding process.\n"},"phone":{"type":["string","null"],"description":"The phone of the individual.
Can be null during the onboarding process.\n"},"address":{"type":["string","null"],"description":"The address of the individual.
Can be null during the onboarding process.\n"},"city":{"type":["string","null"],"description":"The city of the individual.
Can be null during the onboarding process.\n"},"postalCode":{"type":["string","null"],"description":"The postal code of the individual.
Can be null during the onboarding process.\n"},"countryCode":{"type":["string","null"],"description":"The country code of the individual.
Can be null during the onboarding process.\n"},"occupation":{"type":["string","null"],"description":"The occupation of the individual.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.\n"},"jobBusinessSector":{"type":["string","null"],"description":"The job business sector of the individual.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.
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.
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.
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.
Each key can be used in order to download the document.\n"}}}},"individualSourceOfFunds":{"type":["object","null"],"description":"The source of funds of the individual.
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.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.
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.
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.
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.
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.
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.
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":{"get":{"summary":"Returns the list of clients.","description":"The clients are sorted by creation date, in descending order. The most recently created clients appear first.
The clients are paginated, a maximum of 10 clients are returned per page.
If there are more clients to fetch, the response includes a non null `nextPageCursor` field.
The `nextPageCursor` can be injected in the `cursor` parameter to fetch the next page of clients.
If the `nextPageToken` field is null, there are no more clients to fetch.\n","operationId":"getClients","tags":["Clients"],"parameters":[{"name":"cursor","in":"query","description":"The cursor to fetch the next page of clients.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A JSON array of clients.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Client"}},"nextPageCursor":{"type":["string","null"],"format":"date-time"}}}}}},"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.
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."}}}}}} ``` ## Returns a client by ID. > Returns a client by its unique identifier. ```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"}},"schemas":{"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.
\n - ONBOARDING_IN_PROGRESS: The client is in the onboarding process.
\n - ONBOARDING_UNDER_REVIEW: The client is under review.
\n - RESUBMISSION_REQUIRED: Rialto's compliance team has required more information for onboarding, information must be resubmitted.
\n - WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE: The client is waiting for the terms and conditions signature.
\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.
\n - INDIVIDUAL: The client is an individual client.
\n - ENTITY: The client is an entity client.\n"},"company":{"type":["object","null"],"description":"The company information of the client.
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.
Can be null during the onboarding process.\n"},"registeredAddress":{"type":["string","null"],"description":"The registered address of the company.
Can be null during the onboarding process.\n"},"registeredAddressCity":{"type":["string","null"],"description":"The registered address city of the company.
Can be null during the onboarding process.\n"},"registeredAddressPostalCode":{"type":["string","null"],"description":"The registered address postal code of the company.
Can be null during the onboarding process.\n"},"registeredAddressCountryCode":{"type":["string","null"],"description":"The registered address country code of the company.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.\n"},"businessSector":{"type":["string","null"],"description":"The business sector of the company.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.\n"},"turnoverDocuments":{"type":["array"],"description":"The keys of the documents related to the turnover of the company.
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.
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.
Can be null during the onboarding process.
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.
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.
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.
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.
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.
Each key can be used in order to download the document.\n"}}}},"companyRepresentatives":{"type":["array","null"],"description":"The entity representatives of the client.
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.
Can be null during the onboarding process.\n"},"jobTitle":{"type":["string","null"],"description":"The job title of the representative.
Can be null during the onboarding process.\n"},"supportingDocuments":{"type":"array","items":{"type":"string"},"description":"The keys of the documents related to the representative.
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.
\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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Can be null during the onboarding process.\n"},"phone":{"type":["string","null"],"description":"The phone of the individual.
Can be null during the onboarding process.\n"},"address":{"type":["string","null"],"description":"The address of the individual.
Can be null during the onboarding process.\n"},"city":{"type":["string","null"],"description":"The city of the individual.
Can be null during the onboarding process.\n"},"postalCode":{"type":["string","null"],"description":"The postal code of the individual.
Can be null during the onboarding process.\n"},"countryCode":{"type":["string","null"],"description":"The country code of the individual.
Can be null during the onboarding process.\n"},"occupation":{"type":["string","null"],"description":"The occupation of the individual.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.\n"},"jobBusinessSector":{"type":["string","null"],"description":"The job business sector of the individual.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.
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.
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.
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.
Each key can be used in order to download the document.\n"}}}},"individualSourceOfFunds":{"type":["object","null"],"description":"The source of funds of the individual.
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.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.
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.
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.
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.
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.
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.
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/{clientId}":{"get":{"summary":"Returns a client by ID.","description":"Returns a client by its unique identifier.","operationId":"getClient","tags":["Clients"],"responses":{"200":{"description":"A client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}}},"401":{"description":"Invalid API key"},"404":{"description":"Client not found."},"500":{"description":"An unexpected error occurred."}}}}}} ``` ## Deletes a client by ID. > Deletes a client by its unique identifier.\
A deleted client cannot be recovered. It is still queryable but its status is set to \*\*DELETED\*\*.\
It is not possible to create transactions with a deleted client.
```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"}},"schemas":{"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.
\n - ONBOARDING_IN_PROGRESS: The client is in the onboarding process.
\n - ONBOARDING_UNDER_REVIEW: The client is under review.
\n - RESUBMISSION_REQUIRED: Rialto's compliance team has required more information for onboarding, information must be resubmitted.
\n - WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE: The client is waiting for the terms and conditions signature.
\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.
\n - INDIVIDUAL: The client is an individual client.
\n - ENTITY: The client is an entity client.\n"},"company":{"type":["object","null"],"description":"The company information of the client.
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.
Can be null during the onboarding process.\n"},"registeredAddress":{"type":["string","null"],"description":"The registered address of the company.
Can be null during the onboarding process.\n"},"registeredAddressCity":{"type":["string","null"],"description":"The registered address city of the company.
Can be null during the onboarding process.\n"},"registeredAddressPostalCode":{"type":["string","null"],"description":"The registered address postal code of the company.
Can be null during the onboarding process.\n"},"registeredAddressCountryCode":{"type":["string","null"],"description":"The registered address country code of the company.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.\n"},"businessSector":{"type":["string","null"],"description":"The business sector of the company.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.\n"},"turnoverDocuments":{"type":["array"],"description":"The keys of the documents related to the turnover of the company.
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.
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.
Can be null during the onboarding process.
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.
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.
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.
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.
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.
Each key can be used in order to download the document.\n"}}}},"companyRepresentatives":{"type":["array","null"],"description":"The entity representatives of the client.
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.
Can be null during the onboarding process.\n"},"jobTitle":{"type":["string","null"],"description":"The job title of the representative.
Can be null during the onboarding process.\n"},"supportingDocuments":{"type":"array","items":{"type":"string"},"description":"The keys of the documents related to the representative.
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.
\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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Can be null during the onboarding process.\n"},"phone":{"type":["string","null"],"description":"The phone of the individual.
Can be null during the onboarding process.\n"},"address":{"type":["string","null"],"description":"The address of the individual.
Can be null during the onboarding process.\n"},"city":{"type":["string","null"],"description":"The city of the individual.
Can be null during the onboarding process.\n"},"postalCode":{"type":["string","null"],"description":"The postal code of the individual.
Can be null during the onboarding process.\n"},"countryCode":{"type":["string","null"],"description":"The country code of the individual.
Can be null during the onboarding process.\n"},"occupation":{"type":["string","null"],"description":"The occupation of the individual.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.\n"},"jobBusinessSector":{"type":["string","null"],"description":"The job business sector of the individual.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.
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.
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.
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.
Each key can be used in order to download the document.\n"}}}},"individualSourceOfFunds":{"type":["object","null"],"description":"The source of funds of the individual.
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.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.
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.
Can be null during the onboarding process.
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.
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.
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.
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.
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.
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/{clientId}":{"delete":{"summary":"Deletes a client by ID.","description":"Deletes a client by its unique identifier.
A deleted client cannot be recovered. It is still queryable but its status is set to **DELETED**.
It is not possible to create transactions with a deleted client.\n","operationId":"deleteClient","tags":["Clients"],"responses":{"200":{"description":"Client deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}}},"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.md?ask= ``` 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.