GET
/
api
/
partner
/
v2
/
kyc
/
details
cURL
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/kyc/details \
  --header 'partner-api-key: <partner-api-key>'
{
  "status": "ok",
  "data": {
    "aipriseSummary": {
      "verificationResult": "<string>"
    },
    "amlInfo": {
      "entityHits": [
        {
          "entityType": "<string>",
          "name": "<string>",
          "nameMatchScore": 123,
          "alsoKnownAs": [
            "<any>"
          ],
          "amlHits": [
            "<any>"
          ],
          "dateOfBirth": "<string>",
          "dateOfBirthMatchScore": 123,
          "id": "<string>",
          "resolutionStatus": "<string>"
        }
      ],
      "numHits": 123,
      "amlHitSummary": {},
      "searchCriteria": {
        "searchTerm": "<string>",
        "fuzzinessScore": 123,
        "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": 123,
      "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>"
  }
}

Headers

partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Query Parameters

userId
string
required

The user ID

Example:

"2a119021-ed39-4ab4-8690-db610c53f0fb"

Response

200 - application/json
status
string
Example:

"ok"

data
object