/api/partner/v2/kyc/details

Retrieves the latest KYC verification details for a specific user under the partner account.
This endpoint is useful for checking the KYC status after the user has completed the verification process.

🔐 Headers

⚠️

This endpoint requires authentication using a valid partner-api-key.

📥 Query Parameters

📘 Example Request

curl --request GET \
     --url 'https://staging-api.capa.fi/api/partner/v2/kyc/details?userId=2a119021-ed39-4ab4-8690-db610c53f0fb' \
     --header 'accept: application/json' \
     --header 'partner-api-key: {{API-KEY}}'

 

📤 Response Body

The response will include all available verification information, including face match results, fraud checks, ID document data, and AML results.

{
  "aipriseSummary": {
    "verificationResult": "VERIFIED"
  },
  "clientReferenceId": "9486244c-ff7d-4c22-9984-797179d7deaa",
  "clientReferenceData": {
    "personalInfo": {
      "profession": "Employee",
      "phoneNumber": "+524401234567",
      "birthCountry": "MX",
      "taxId": "LOZG7802117B9"
    }
  },
  "faceLivenessInfo": {
    "result": "PASSED",
    "status": "APPROVED"
  },
  "faceMatchInfo": {
    "faceMatchScore": 0.97,
    "result": "PASSED",
    "status": "APPROVED"
  },
  "fraudInsights": {
    "result": "CLEAN",
    "status": "APPROVED"
  },
  "idInfo": {
    "fullName": "Juan Perez",
    "birthDate": "1990-01-01",
    "gender": "M",
    "nationality": "MX",
    "idNumber": "X12345678",
    "idType": "INE"
  },
  "amlInfo": {
    "numHits": 0,
    "entityHits": []
  },
  "verificationSessionId": "vs_1234567890abcdef",
  "media": {
    "frontIdImageUrl": "https://cdn.capa.fi/id/front.jpg",
    "backIdImageUrl": "https://cdn.capa.fi/id/back.jpg",
    "selfieImageUrl": "https://cdn.capa.fi/selfie.jpg",
    "selfieVideoUrl": "https://cdn.capa.fi/selfie.mp4"
  }
}

 

⚠️ Important Notes & Requirements

• Partner API Key is mandatory: All requests must include a valid PartnerApiKey in the header. Get your API key.
• User must exist: The provided userId must reference a user that was created using the Create User endpoint.
• Session Completion Required: Verification results are only available after the user has completed the full KYC session.
• Partial Data Possibility: Depending on the verification provider and user input, some fields in the response may be missing or marked as null.
• No Side Effects: This endpoint is read-only and does not trigger any updates or notifications.
• Compliance Responsibilities: It's up to each partner to determine how to act upon the returned verification and AML data.
• Retry Strategy: If the session has expired or was inconclusive, a new verification session should be initiated using the KYC Link Generation endpoint.

✅ Use Cases

• Compliance Review
  After the user finishes KYC, partners can retrieve all details (ID, liveness, AML, etc.) for internal or regulatory review.

• Automated Decisioning
  Use face match scores, ID info, and fraud signals to automatically determine onboarding acceptance.

• Support Investigation
  In cases of dispute or manual review, support agents can inspect full verification artifacts using this data.

• AML Screening Integration
  Combine amlInfo results into your internal or third-party AML workflows to comply with regional regulations.