> ## Documentation Index > Fetch the complete documentation index at: https://docs.lumx.io/llms.txt > Use this file to discover all available pages before exploring further. # Read a customer > This endpoint reads a customer. ## OpenAPI ````yaml /openapi/api-production.yaml get /customers/{id} openapi: 3.1.0 info: version: 1.0.0 title: Lumx API description: >- A cross-border banking API with instant settlements and unmatched liquidity, powered by stablecoins. servers: - url: https://api.lumx.io - url: https://api-sandbox.lumx.io security: [] paths: /customers/{id}: get: tags: - Customers summary: Read a customer description: This endpoint reads a customer. parameters: - name: id in: path required: true schema: type: string format: uuid description: Customer's unique identifier. - name: includeBalances in: query required: false schema: type: boolean description: Whether to include balances in the response body. - name: includeTransactionLimits in: query required: false schema: type: boolean description: Whether to include transaction limits in the response body. responses: '200': description: Resource successfully retrieved. content: application/json: examples: Business: $ref: '#/components/examples/CustomerBusinessExample' Individual: $ref: '#/components/examples/CustomerIndividualExample' schema: $ref: '#/components/schemas/CustomerResponse' security: - apiKey: [] components: examples: CustomerBusinessExample: value: id: 3c90c3cc-0d44-4b50-8888-8dd25736052a type: BUSINESS legalName: Lumx S.A taxId: 42.887.120/0001-00 incorporationDate: '2020-01-01' country: BRA email: hello@lumx.io verification: status: NOT_STARTED level: STANDARD link: https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44 additionalInformation: type: BUSINESS phone: '+5511999999999' address: country: BRA line1: Av. Paulista, 1000, Sala 101 city: São Paulo state: SP postalCode: 01310-100 monthlyVolumeInUSD: '50000.00' transactionVolumeInUSD: '10000.00' jurisdictions: - BRA - USA - EU involvedActivities: - NONE transactionCounterparties: - SELF companyType: BLOCKCHAIN_SOFTWARE_COMPANY annualRevenue: '1000000.00' monthlyTransactionVolume: '100000.00' complianceAndAML: >- We have a dedicated compliance team and use third-party AML screening tools. isRegulatedActivity: false regulatedActivityDetails: '' website: https://example.com sourceOfFunds: COMPANY servicesProvided: >- We provide blockchain-based payment infrastructure for B2B cross-border transactions. accounts: - id: d06d342c-629a-4d99-a26f-34e8ea528403 currency: EUR - id: af04e979-360a-428a-84e6-cbd8ffc4942b currency: USD - id: 8412f484-32fe-418f-80d1-99eb1b3ba7f3 currency: BRL transactionLimits: single: max: '10000.00' daily: max: '100000.00' used: '0.00' remaining: '100000.00' monthly: max: '1000000.00' used: '0.00' remaining: '1000000.00' metadata: {} createdAt: '2021-01-01T00:00:00Z' updatedAt: '2021-01-01T00:00:00Z' CustomerIndividualExample: value: id: 3c90c3cc-0d44-4b50-8888-8dd25736052a type: INDIVIDUAL name: William Default taxId: 123.456.789-00 birthDate: '1990-01-01' country: BRA email: william.default@example.com verification: status: NOT_STARTED level: STANDARD link: https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44 additionalInformation: type: INDIVIDUAL phone: '+5511999999999' firstName: William middleName: '' lastName: Default address: country: BRA line1: Rua das Flores, 123 city: São Paulo state: SP postalCode: 01234-567 monthlyVolumeInUSD: '5000' transactionVolumeInUSD: '1000' jurisdictions: - BRA - USA involvedActivities: - NONE transactionCounterparties: - SELF - MERCHANTS_SUPPLIERS professionalSituation: EMPLOYEE professionalOccupation: Software Engineer sourceOfFunds: EMPLOYMENT transactionLimits: single: max: '10000.00' daily: max: '100000.00' used: '0.00' remaining: '100000.00' monthly: max: '1000000.00' used: '0.00' remaining: '1000000.00' metadata: {} createdAt: '2021-01-01T00:00:00Z' updatedAt: '2021-01-01T00:00:00Z' schemas: CustomerResponse: oneOf: - title: Business allOf: - type: object properties: id: type: string description: Customer's unique identifier. format: uuid readOnly: true example: 3c90c3cc-0d44-4b50-8888-8dd25736052a - $ref: '#/components/schemas/CustomerBusiness' - $ref: '#/components/schemas/CustomerResponseFields' - title: Individual allOf: - type: object properties: id: type: string description: Customer's unique identifier. format: uuid readOnly: true example: 3c90c3cc-0d44-4b50-8888-8dd25736052a - $ref: '#/components/schemas/CustomerIndividual' - $ref: '#/components/schemas/CustomerResponseFields' CustomerBusiness: title: Business type: object properties: type: type: string description: Customer's type. enum: - BUSINESS legalName: type: string description: Customer's legal name. example: Lumx S.A taxId: type: string description: >- Customer's tax ID. It must be a valid tax ID in the country where the company is incorporated. example: 42.887.120/0001-00 incorporationDate: type: string description: Customer's incorporation date. format: date example: '2020-01-01' country: type: string description: Customer's country (ISO 3166-1 alpha-3). example: BRA email: type: string description: Customer's email. example: hello@lumx.io metadata: type: object description: >- Optional metadata object to attach to the customer. Accepts any valid JSON object. additionalProperties: true example: externalId: biz_456 tier: enterprise CustomerResponseFields: type: object properties: taxId: description: Customer's tax ID. wallets: type: array description: >- Customer's wallets by blockchain. Only returned when the customer's `verification.status` is `APPROVED`. items: type: object properties: blockchain: type: string enum: - ETHEREUM - BASE - TRON - POLYGON description: Blockchain network. example: POLYGON address: type: string description: Wallet address on this blockchain. example: '0x1234567890123456789012345678901234567890' blockExplorerUrl: type: string description: Block explorer URL for this wallet. example: >- https://polygonscan.com/address/0x1234567890123456789012345678901234567890 isDefault: type: boolean description: Whether this is the default wallet. example: true balances: type: array description: Stablecoin balances on this wallet. items: $ref: '#/components/schemas/CustomerBalance' verification: $ref: '#/components/schemas/CustomerVerification' requirements: type: array description: List of document requirements for KYC/KYB verification. items: type: object properties: name: type: string description: Document requirement name. enum: - ID_CARD - PASSPORT - DRIVERS_LICENSE - BANK_STATEMENT - INCOME_TAX_RETURN - DELIVERY_RECEIPT - SELFIE - ADDITIONAL_INFORMATION - INCORPORATION_ARTICLES - POWER_OF_ATTORNEY - DIRECTORS_REGISTRY - SHAREHOLDER_REGISTRY - REGULATED_ACTIVITY_DOCUMENT - SIGNED_BALANCE_SHEET - SIGNED_CORPORATE_STRUCTURE_CHART - SIGNED_INCOME_STATEMENT example: ID_CARD status: type: string description: Document requirement status. enum: - NOT_SENT - PENDING - APPROVED - TEMPORARY_REJECTION - FINAL_REJECTION example: NOT_SENT example: - name: ID_CARD status: NOT_SENT - name: PASSPORT status: NOT_SENT - name: BANK_STATEMENT status: NOT_SENT additionalInformation: type: object description: >- Additional information submitted for KYC/KYB verification. Only present after sending additional information. accounts: type: array description: >- Virtual fiat accounts linked to the customer for receiving payments. Optional—only present when the customer has at least one account. Each entry exposes the account's `id` and `currency`. items: type: object properties: id: type: string format: uuid description: Account's unique identifier. example: d06d342c-629a-4d99-a26f-34e8ea528403 currency: type: string description: Account's currency. enum: - BRL - USD - EUR - MXN example: EUR transactionLimits: type: object description: Customer's transaction limits. properties: single: type: object description: Single transaction limit for the customer. properties: max: type: string description: Maximum amount allowed for a single transaction. example: '10000.00' daily: type: object description: Daily limit for the customer. properties: max: type: string description: Maximum daily amount. example: '100000.00' used: type: string description: Amount used today. example: '0.00' remaining: type: string description: Remaining daily amount. example: '100000.00' monthly: type: object description: Monthly limit for the customer. properties: max: type: string description: Maximum monthly amount. example: '1000000.00' used: type: string description: Amount used this month. example: '0.00' remaining: type: string description: Remaining monthly amount. example: '1000000.00' metadata: type: object description: >- Custom metadata associated with the customer. Returns an empty object if no metadata was provided. additionalProperties: true example: externalId: usr_123 tier: premium createdAt: type: string description: Creation date and time (UTC). format: date-time example: '2021-01-01T00:00:00Z' updatedAt: type: string description: Last update date and time (UTC). format: date-time example: '2021-01-01T00:00:00Z' CustomerIndividual: title: Individual type: object properties: type: type: string description: Customer's type. enum: - INDIVIDUAL example: INDIVIDUAL name: type: string description: Customer's full name. example: William Default taxId: type: string description: >- Customer's tax ID. It must be a valid tax ID in the country where the customer lives. example: 123.456.789-00 birthDate: type: string description: Customer's birth date. format: date example: '1990-01-01' country: type: string description: Customer's country (ISO 3166-1 alpha-3). enum: - BRA example: BRA email: type: string description: Customer's email. example: william.default@example.com metadata: type: object description: >- Optional metadata object to attach to the customer. Accepts any valid JSON object. additionalProperties: true example: externalId: usr_123 tier: premium CustomerBalance: type: object description: Customer's balance. properties: currency: type: string description: Balance currency. enum: - USDC - USDT amount: type: string description: Balance amount. example: '1000.00' updatedAt: type: string description: Last update date and time (UTC). example: '2021-01-01T00:00:00Z' CustomerVerification: type: object description: Customer's verification. properties: status: type: string description: Verification status. enum: - NOT_STARTED - UNDER_VERIFICATION - APPROVED - TEMPORARY_REJECTION - FINAL_REJECTION example: NOT_STARTED level: type: string description: Verification level. enum: - STANDARD example: STANDARD link: type: string description: Verification link. example: https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44 securitySchemes: apiKey: type: http scheme: bearer description: Bearer authentication header on the format `Bearer `. ````