Skip to main content
POST
/
v1
/
products
/
kyb_certificate
/
query
Query consolidated KYB certificate data for a business
curl --request POST \
  --url https://api.example.com/v1/products/kyb_certificate/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "network_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "furnishing_entity_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "consent_id": "<string>",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "meta": {
      "network_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "business_identity_verification": {
      "assertions": {
        "business_identity_verification_assertion": true,
        "business_identity_verification_performed_timestamp": "2023-11-07T05:31:56Z"
      },
      "data": {
        "business_formation_document_artifact": "<string>",
        "business_dba_name": "<string>",
        "business_website_url": "<string>",
        "business_jurisdiction_of_formation": "<string>",
        "business_registration_identifier": "<string>",
        "business_identity_verification_sources": [
          "<string>"
        ],
        "business_entity_type": "<string>",
        "business_registration_status": "<string>",
        "business_operational_existence_status": "<string>",
        "business_tax_id_validation_result": "<string>",
        "business_address_verification_result": "<string>",
        "business_registered_address": {
          "line_1": "<string>",
          "line_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "country": "<string>"
        },
        "business_operating_address": {
          "line_1": "<string>",
          "line_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "country": "<string>"
        }
      },
      "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "business_ownership_control_verification": {
      "assertions": {
        "business_ownership_control_verification_assertion": true,
        "business_ownership_control_verification_timestamp": "2023-11-07T05:31:56Z"
      },
      "data": {
        "business_ownership_evidence_artifact": "<string>",
        "business_dba_name": "<string>",
        "business_website_url": "<string>",
        "business_jurisdiction_of_formation": "<string>",
        "business_registration_identifier": "<string>",
        "business_ownership_control_verification_overall_primary_source": "<string>",
        "business_authority_determination_basis": "<string>",
        "business_authorized_representatives_identified_count": 123,
        "business_beneficial_owners_identified_count": 123,
        "business_beneficial_ownership_determination_method": "<string>",
        "business_beneficial_ownership_threshold_applied": "<string>",
        "business_control_authority_evidence_reviewed_type": "<string>",
        "business_control_determination_basis": "<string>",
        "business_control_persons_identified_count": 123,
        "business_ownership_control_verification_overall_status": "<string>",
        "business_ownership_evidence_reviewed_type": "<string>"
      },
      "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "business_risk_compliance_assessment": {
      "assertions": {
        "business_risk_compliance_verification_assertion": true,
        "business_risk_compliance_timestamp": "2023-11-07T05:31:56Z"
      },
      "data": {
        "business_dba_name": "<string>",
        "business_website_url": "<string>",
        "business_jurisdiction_of_formation": "<string>",
        "business_registration_identifier": "<string>",
        "business_primary_activity_classification_code": "<string>",
        "business_primary_activity_classification_system": "<string>",
        "business_activity_risk_level": "<string>",
        "business_adverse_media_assessment_result": "<string>",
        "business_compliance_screening_scope_applied": "<string>",
        "business_restricted_activity_assessment_result": "<string>",
        "business_risk_compliance_assessment_overall_primary_source": "<string>",
        "business_risk_compliance_assessment_overall_status": "<string>",
        "business_risk_compliance_assessment_timestamp": "2023-11-07T05:31:56Z",
        "business_sanctions_screening_result": "<string>"
      },
      "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "certificate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "query_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
network_ids
string<uuid>[]
required

Networks to query across; the single policy is applied to all of them.

Minimum array length: 1
​
policy_id
string<uuid> | null

Querying policy applied across every network in network_ids. If omitted, each network's default policy is used.

​
furnishing_entity_ids
string<uuid>[] | null

Optional furnishing-entity scope. When omitted or empty, data from all furnishers is considered.

​
consent_id
string | null

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

​
business_id
string<uuid> | null

Business profile primary key (Business.id) for permissible-purpose (FCRA) queries.

Response

Successful Response

​
business_id
string<uuid>
required
​
result
KybCertificateNetworkResult · object
required

Consolidated certificate resolution across all queried networks.

​
certificate_id
string<uuid> | null
​
query_event_id
string<uuid> | null