# User

## Returns a user's information.

> Returns the user's information.\<br /> Response schema is polymorphic, it can be either a CompanyUser or an IndividualClient depending of the underlying user type.<br>

```json
{"openapi":"3.1.0","info":{"title":"Rialto API","version":"1.0.0"},"servers":[{"url":"https://api.rialtobridge.xyz/api/client/v1","description":"Main (production) server for the Rialto Client API"},{"url":"https://staging.api.rialtobridge.xyz/api/client/v1","description":"Test (staging) server for the Rialto Client API"},{"url":"http://localhost:3002/api/client/v1","description":"Development server for the Rialto Client 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."},"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"}}}},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the client."}}}}},"paths":{"/user":{"get":{"summary":"Returns a user's information.","description":"Returns the user's information.<br /> Response schema is polymorphic, it can be either a CompanyUser or an IndividualClient depending of the underlying user type.\n","operationId":"getUser","tags":["User"],"responses":{"200":{"description":"The user's information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}}},"401":{"description":"Invalid API key"},"500":{"description":"An unexpected error occurred."}}}}}}
```