> ## Documentation Index > Fetch the complete documentation index at: https://developer.paywint.com/llms.txt > Use this file to discover all available pages before exploring further. # Get KYB > This endpoint: - Verifies the platform and user relationship - Retrieves the KYB record associated with the given user ID - Returns detailed KYB data if found, otherwise raises a 404 error ## OpenAPI ````yaml GET /api/platform/kyb/{user_id} openapi: 3.1.0 info: title: paywint version: 0.1.0 servers: - url: http://localhost:8001 - url: https://api.pw.wintpay.com - url: https://test.pw.wintpay.com - url: https://api.sandbox.paywint.com security: [] paths: /api/platform/kyb/{user_id}: get: tags: - Platform User KYB summary: Get KYB of a user description: |- This endpoint: - Verifies the platform and user relationship - Retrieves the KYB record associated with the given user ID - Returns detailed KYB data if found, otherwise raises a 404 error operationId: get_user_kyb_api_platform_kyb__user_id__get parameters: - name: user_id in: path required: true schema: type: string format: uuid description: >- Unique identifier (UUID) of the user whose KYB record is being retrieved. title: User Id description: >- Unique identifier (UUID) of the user whose KYB record is being retrieved. example: f47ac10b-****-****-****-0e02b2c3d479 - name: X-Platform-ID in: header required: true schema: type: string format: uuid description: >- Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request. title: X-Platform-Id description: >- Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request. - name: X-Signature in: header required: true schema: type: string description: >- HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`. title: X-Signature description: >- HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CommonResponse_PlatformKybRead_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: CommonResponse_PlatformKybRead_: properties: success: type: boolean title: Success description: Indicates whether the request was processed successfully. default: true example: true message: type: string title: Message description: >- A short, human-readable message describing the result of the request. default: Success example: Operation completed. data: anyOf: - $ref: '#/components/schemas/PlatformKybRead' - type: 'null' description: The main response payload, if applicable queryGeneratedTime: anyOf: - type: number - type: 'null' title: Querygeneratedtime description: >- The Unix timestamp (in seconds) indicating when the response was generated. default: 1782303609.673092 example: 1718006400 type: object title: CommonResponse[PlatformKybRead] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError PlatformKybRead: properties: user_id: anyOf: - type: string format: uuid - type: 'null' title: User Id description: ID of the user or account that owns the business profile. business_name: anyOf: - type: string - type: 'null' title: Business Name description: Legal registered name of the business. dba: anyOf: - type: string - type: 'null' title: Dba description: '"Doing Business As" (trade name) if it differs from the legal name.' business_phone: anyOf: - type: string - type: 'null' title: Business Phone description: Primary phone number used for business inquiries. business_email: anyOf: - type: string - type: 'null' title: Business Email description: Primary email address used for business correspondence. address: anyOf: - type: string - type: 'null' title: Address description: Street address of the business headquarters. city: anyOf: - type: string - type: 'null' title: City description: City where the business is located. state: anyOf: - type: string - type: 'null' title: State description: State, province, or region. zip: anyOf: - type: string - type: 'null' title: Zip description: Postal / ZIP code. country: anyOf: - type: string - type: 'null' title: Country description: Country of domicile (ISO-3166 alpha-2 preferred). business_description: anyOf: - type: string - type: 'null' title: Business Description description: Short description of the company's products or services. business_id_type: anyOf: - type: string - type: 'null' title: Business Id Type description: >- Industry sector the business operates in, e.g., 'Technology', 'Finance', 'Healthcare'. website: anyOf: - type: string - type: 'null' title: Website description: Public website URL. mcc: anyOf: - type: string - type: 'null' title: Mcc description: Merchant Category Code reflecting the primary line of business. formation_date: anyOf: - type: string - type: 'null' title: Formation Date description: Date the legal entity was formed (MM-DD-YYYY). entity_type: anyOf: - type: string - type: 'null' title: Entity Type description: Legal entity type (e.g. 'ent1', 'ent2', 'ent3'). status: anyOf: - type: string - type: 'null' title: Status description: Current KYB review status (e.g. 'pending', 'approved', 'rejected'). document_1: anyOf: - type: string - type: 'null' title: Document 1 description: First supporting document uploaded for KYB verification. document_2: anyOf: - type: string - type: 'null' title: Document 2 description: Second supporting document uploaded for KYB verification. document_3: anyOf: - type: string - type: 'null' title: Document 3 description: Third supporting document uploaded for KYB verification. document_4: anyOf: - type: string - type: 'null' title: Document 4 description: Fourth supporting document uploaded for KYB verification. document_5: anyOf: - type: string - type: 'null' title: Document 5 description: Fifth supporting document uploaded for KYB verification. type: object title: PlatformKybRead ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError ````