> ## Documentation Index > Fetch the complete documentation index at: https://docs.capa.fi/llms.txt > Use this file to discover all available pages before exploring further. # Get KYC Details Retrieves the latest KYC verification details for a user. Use this to check verification status, inspect ID data, face match scores, AML results, and fraud signals after the user completes the KYC session. *** ## Important Notes * Verification results are only available **after** the user completes the full KYC session. * Some response fields may be `null` depending on the verification provider and user input. * This is a read-only endpoint — it does not trigger updates or notifications. * If a session has expired or was inconclusive, generate a new verification link via [KYC Link Generation](/reference/userpartnercontrollerv2_createverificationlink). *** ## Use Cases * **Compliance review**: Inspect ID, liveness, AML, and fraud data for regulatory review. * **Automated decisioning**: Use face match scores and fraud signals to determine onboarding acceptance. * **Support investigation**: Inspect verification artifacts during dispute resolution. *** ## Error Codes ### Common Errors | HTTP Status | Code | Message | | ----------- | ---------------------- | ---------------------------------- | | 401 | `UNAUTHORIZED` | "API Key is missing" | | 401 | `UNAUTHORIZED` | "Invalid API Key format" | | 401 | `UNAUTHORIZED` | "Invalid API Key" | | 403 | `INVALID_PARTNER_FLOW` | "The partner has an invalid flow." | ### User Ownership Errors | HTTP Status | Code | Message | | ----------- | -------------- | ---------------------------------------------------- | | 401 | `UNAUTHORIZED` | "Partner information is required for this operation" | | 401 | `UNAUTHORIZED` | "User is not associated with the partner" | ### Endpoint-Specific Errors | HTTP Status | Code | Message | | ----------- | ----------------------- | --------------------------------- | | 404 | `NOT_FOUND_ERROR` | "Requested KYC was not found" | | 500 | `INTERNAL_SERVER_ERROR` | "Failed to get user verification" | ## OpenAPI ````yaml reference/openapi/KYCPartnerControllerV2_getUserVerificationDetails.json GET /api/partner/v2/kyc/details openapi: 3.0.0 info: title: Capa Partner API - V2 description: >- Partner API for integrating cryptocurrency on-ramp and off-ramp services using Capa's infrastructure. Enable your users to seamlessly convert between fiat and crypto. version: v2 contact: {} servers: - url: https://api.sandbox.capa.fi - url: https://production-api.capa.fi security: [] paths: /api/partner/v2/kyc/details: get: tags: - kyc operationId: KYCPartnerControllerV2_getUserVerificationDetails parameters: - name: userId required: true in: query description: The user ID schema: example: 2a119021-ed39-4ab4-8690-db610c53f0fb type: string responses: '200': description: >- Returns the KYC (Know Your Customer) verification details for the user. content: application/json: schema: type: object properties: status: type: string example: ok data: type: object properties: aipriseSummary: type: object description: '@description General result of the verification.' properties: verificationResult: type: string amlInfo: type: object properties: entityHits: type: array items: type: object properties: entityType: type: string name: type: string nameMatchScore: type: number alsoKnownAs: type: array amlHits: type: array dateOfBirth: type: string dateOfBirthMatchScore: type: number id: type: string resolutionStatus: type: string numHits: type: number amlHitSummary: type: object searchCriteria: type: object properties: searchTerm: type: string fuzzinessScore: type: number exactMatch: type: boolean clientReferenceData: type: object properties: personalInfo: type: object properties: profession: type: string phoneNumber: type: string birthCountry: type: string taxId: type: string faceLivenessInfo: type: object properties: checkSummary: type: object result: type: string section_id: type: string status: type: string statusReasons: type: array items: type: object properties: code: type: string message: type: string warnings: type: array items: type: object properties: code: type: string message: type: string warningId: type: string resolutionStatus: type: string faceMatchInfo: type: object properties: faceMatchScore: type: number checkSummary: type: object result: type: string section_id: type: string status: type: string statusReasons: type: array items: type: object properties: code: type: string message: type: string warnings: type: array items: type: object properties: code: type: string message: type: string warningId: type: string resolutionStatus: type: string fraudInsights: type: object properties: relatedSessionInsights: type: object properties: result: type: string section_id: type: string status: type: string statusReasons: type: array items: type: object properties: code: type: string message: type: string warnings: type: array items: type: object properties: code: type: string message: type: string warningId: type: string resolutionStatus: type: string result: type: string section_id: type: string status: type: string statusReasons: type: array items: type: object properties: code: type: string message: type: string warnings: type: array items: type: object properties: code: type: string message: type: string warningId: type: string resolutionStatus: type: string idInfo: type: object properties: address: type: object properties: fullAddress: type: string birthDate: type: string checkSummary: type: object documentDetails: type: object firstName: type: string idExpiryDate: type: string idIssueDate: type: string idType: type: string idNumber: type: string middleName: type: string lastName: type: string secondLastName: type: string fullName: type: string gender: type: string nationality: type: string nationalityCode: type: string issueCountry: type: string issueCountryCode: type: string result: type: string section_id: type: string status: type: string statusReasons: type: array items: type: object properties: code: type: string message: type: string warnings: type: array items: type: object properties: code: type: string message: type: string warningId: type: string resolutionStatus: type: string media: type: object properties: frontIdImageUrl: type: string backIdImageUrl: type: string selfieImageUrl: type: string selfieVideoUrl: type: string clientReferenceId: type: string description: >- @description Represents the userId in our system, is the same as the one return when each partner create a user. createdAt: type: string verificationSessionId: type: string description: >- The ID of the verification session. aka `externalResourceId` in our system. required: - amlInfo - clientReferenceData - faceLivenessInfo - faceMatchInfo - fraudInsights - idInfo x-readme-ref-name: GetUserVerificationResultHttpResponse example: status: ok data: aipriseSummary: verificationResult: string amlInfo: entityHits: - entityType: string name: string nameMatchScore: 0 alsoKnownAs: [] amlHits: [] dateOfBirth: string dateOfBirthMatchScore: 0 id: string resolutionStatus: string numHits: 0 amlHitSummary: {} searchCriteria: searchTerm: string fuzzinessScore: 0 exactMatch: true clientReferenceData: personalInfo: profession: string phoneNumber: string birthCountry: string taxId: string faceLivenessInfo: checkSummary: {} result: string section_id: string status: string statusReasons: - code: string message: string warnings: - code: string message: string warningId: string resolutionStatus: string faceMatchInfo: faceMatchScore: 0 checkSummary: {} result: string section_id: string status: string statusReasons: - code: string message: string warnings: - code: string message: string warningId: string resolutionStatus: string fraudInsights: relatedSessionInsights: result: string section_id: string status: string statusReasons: - code: string message: string warnings: - code: string message: string warningId: string resolutionStatus: string result: string section_id: string status: string statusReasons: - code: string message: string warnings: - code: string message: string warningId: string resolutionStatus: string idInfo: address: fullAddress: string birthDate: string checkSummary: {} documentDetails: {} firstName: string idExpiryDate: string idIssueDate: string idType: string idNumber: string middleName: string lastName: string secondLastName: string fullName: string gender: string nationality: string nationalityCode: string issueCountry: string issueCountryCode: string result: string section_id: string status: string statusReasons: - code: string message: string warnings: - code: string message: string warningId: string resolutionStatus: string media: frontIdImageUrl: string backIdImageUrl: string selfieImageUrl: string selfieVideoUrl: string clientReferenceId: string createdAt: string verificationSessionId: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false code: INVALID_USER_INPUT_ERROR message: Invalid User Input '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: UNAUTHORIZED: value: success: false code: UNAUTHORIZED message: API Key is missing UNAUTHORIZED_2: value: success: false code: UNAUTHORIZED message: Invalid API Key format UNAUTHORIZED_3: value: success: false code: UNAUTHORIZED message: Invalid API Key '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: NOT_FOUND_ERROR: value: success: false code: NOT_FOUND_ERROR message: Requested resource was not found NOT_FOUND_ERROR_2: value: success: false code: NOT_FOUND_ERROR message: Requested KYC was not found '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false code: INTERNAL_SERVER_ERROR message: Internal server error security: - PartnerApiKey: [] components: schemas: ErrorResponse: type: object properties: success: type: boolean example: false code: type: string description: Machine-readable error code. message: type: string description: Human-readable error message. errors: type: array description: Optional per-field validation details. items: type: object properties: field: type: string message: type: string required: - success - code - message securitySchemes: PartnerApiKey: type: apiKey in: header name: partner-api-key description: API key for the affiliated partner performing the request. ````