Skip to main content
POST
/
certificates
/
kyc
/
query
Query consolidated KYC certificate data for a consumer
curl --request POST \
  --url https://api.example.com/certificates/kyc/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "consent_id": "<string>",
  "consumer_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "query_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "consumer_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "document_capture": {
    "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assertions": {
      "document_capture_assertion": true,
      "document_capture_timestamp": "2023-11-07T05:31:56Z"
    },
    "data": {
      "document_artifact": "<string>",
      "document_type": "<string>",
      "document_issuing_state": "<string>",
      "document_number": "<string>",
      "document_issue_date": "<string>",
      "document_expiration_date": "<string>",
      "document_capture_method": "<string>"
    }
  },
  "document_review": {
    "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assertions": {
      "document_attribute_review_assertion": true,
      "document_attribute_review_timestamp": "2023-11-07T05:31:56Z"
    },
    "data": {
      "document_review_method": "<string>",
      "document_tamper_review_performed": true,
      "document_tamper_indicators_observed": true,
      "is_document_machine_readable_data_validation_performed": true,
      "is_document_machine_readable_data_validation_consistent_with_document_face": true
    }
  },
  "biometric_capture": {
    "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assertions": {
      "biometric_capture_assertion": true,
      "biometric_capture_timestamp": "2023-11-07T05:31:56Z"
    },
    "data": {
      "biometric_artifact": "<string>",
      "biometric_capture_method": "<string>"
    }
  },
  "biometric_review": {
    "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assertions": {
      "biometric_review_assertion": true,
      "biometric_review_timestamp": "2023-11-07T05:31:56Z"
    },
    "data": {
      "biometric_image_quality_sufficient_for_comparison": true,
      "biometric_comparison_reference": "<string>",
      "biometric_comparison_outcome": "<string>"
    }
  },
  "liveness_capture": {
    "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assertions": {
      "liveness_capture_assertion": true,
      "liveness_capture_timestamp": "2023-11-07T05:31:56Z"
    },
    "data": {
      "liveness_artifact": "<string>",
      "liveness_capture_environment": "<string>"
    }
  },
  "liveness_review": {
    "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assertions": {
      "liveness_review_assertion": true,
      "liveness_review_timestamp": "2023-11-07T05:31:56Z"
    },
    "data": {
      "liveness_review_method": "<string>",
      "liveness_review_outcome": "<string>",
      "liveness_review_confidence_tier": "<string>"
    }
  },
  "address_capture": {
    "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assertions": {
      "address_capture_assertion": true,
      "address_capture_timestamp": "2023-11-07T05:31:56Z"
    },
    "data": {
      "address_category": "<string>"
    }
  },
  "address_verification": {
    "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assertions": {
      "address_verification_assertion": true,
      "address_verification_timestamp": "2023-11-07T05:31:56Z"
    },
    "data": {
      "address_verification_methods": [
        "<string>"
      ],
      "address_verification_outcomes": [
        "<string>"
      ],
      "total_address_sources_consulted": 123,
      "address_source_count_full_match": 123,
      "address_source_count_inconclusive": 123,
      "address_source_count_no_match": 123,
      "address_source_count_partial_match_street_and_city_only": 123,
      "address_source_count_partial_match_zip_only": 123
    }
  },
  "identity_corroboration": {
    "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assertions": {
      "is_identity_corroboration_performed": true,
      "identity_corroboration_timestamp": "2023-11-07T05:31:56Z"
    },
    "data": {
      "identity_elements_corroborated": "<string>",
      "identity_corroboration_methods": [
        "<string>"
      ],
      "identity_corroboration_outcomes": [
        "<string>"
      ],
      "total_identity_corroboration_sources_consulted": 123,
      "identity_corroboration_source_count_full_match": 123,
      "identity_corroboration_source_count_inconclusive": 123,
      "identity_corroboration_source_count_no_match": 123,
      "identity_corroboration_source_count_partial_match": 123
    }
  }
}

Body

application/json

Consent token — system resolves identity + applies field access filtering.

consumer_entity_id
string<uuid> | null

Direct entity lookup for permissible-purpose (FCRA) queries.

Response

Successful Response

query_event_id
string<uuid>
required
consumer_entity_id
string<uuid>
required
document_capture
DocumentCaptureSubProduct · object
document_review
DocumentReviewSubProduct · object
biometric_capture
BiometricCaptureSubProduct · object
biometric_review
BiometricReviewSubProduct · object
liveness_capture
LivenessCaptureSubProduct · object
liveness_review
LivenessReviewSubProduct · object
address_capture
AddressCaptureSubProduct · object
address_verification
AddressVerificationSubProduct · object
identity_corroboration
IdentityCorroborationSubProduct · object