Get KYC Details

cURL

curl --request GET \
  --url https://api.sandbox.capa.fi/api/partner/v2/kyc/details \
  --header 'partner-api-key: <api-key>'

const options = {method: 'GET', headers: {'partner-api-key': '<api-key>'}};

fetch('https://api.sandbox.capa.fi/api/partner/v2/kyc/details', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.capa.fi/api/partner/v2/kyc/details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "partner-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.capa.fi/api/partner/v2/kyc/details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("partner-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.capa.fi/api/partner/v2/kyc/details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["partner-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

GET

api

partner

kyc

details

cURL

curl --request GET \
  --url https://api.sandbox.capa.fi/api/partner/v2/kyc/details \
  --header 'partner-api-key: <api-key>'

const options = {method: 'GET', headers: {'partner-api-key': '<api-key>'}};

fetch('https://api.sandbox.capa.fi/api/partner/v2/kyc/details', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.capa.fi/api/partner/v2/kyc/details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "partner-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.capa.fi/api/partner/v2/kyc/details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("partner-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.capa.fi/api/partner/v2/kyc/details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["partner-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

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.

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”

Authorizations

partner-api-key

string

header

required

API key for the affiliated partner performing the request.

Query Parameters

userId

string

required

The user ID

Example:

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

Response

Returns the KYC (Know Your Customer) verification details for the user.

status

string

Example:

"ok"

data

object

Show child attributes

Request Signature Get KYB Details

⌘I

​Important Notes

​Use Cases

​Error Codes

​Common Errors

​User Ownership Errors

​Endpoint-Specific Errors

Authorizations

Query Parameters

Response

Important Notes

Use Cases

Error Codes

Common Errors

User Ownership Errors

Endpoint-Specific Errors