Query Participants

Get participant full info

Changed on

This endpoint returns Participant full info.

get/participant/{participant_code}/full_info

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/participant/{participant_code}/full_info
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

Path parameters

participant_codestring required
Example:ABCDEF

Unique participant identifier. Always 6 uppercase alphanumeric characters.

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Successfully retrieved participant full information. Including all profile details, KYC status, limits, and account configuration.

Example response

{
  "message": {
    "participant_code": "CUST01",
    "status": "approved",
    "action": "approved",
    "action_reason": "compliance_issue",
    "user_email": "ops-user-1234",
    "participant_type": "INDIVIDUAL",
    "name": "Jane Doe",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane.doe@example.com",
    "contact_number": "+15557778888",
    "website": "www.test.com",
    "address_one": "123 Main St.",
    "address_two": "Suite 1000",
    "city": "Chicago",
    "postal_code": "12345",
    "date_established": "1985-09-02",
    "legal_name": "Legal Name",
    "entity_type": "partnership",
    "state_or_province_of_organization": "IL",
    "date_of_birth": "1985-09-02",
    "submission_method": "web",
    "signed_timestamp": 1603378501286,
    "created_at": 1603378501286,
    "last_updated": 1680643465352,
    "platform_updated_at": 1603378501286,
    "kyc_timestamp": 1603378501286,
    "sanction_screening_timestamp": 1603378501286,
    "kyc_participant_track": "vendor reliance",
    "jurisdiction_updated_at": 1731354732292,
    "kyc_tier": "FULL",
    "subdomain": "subdomain",
    "jurisdiction_code": "US-IL",
    "id_number": "123456789",
    "id_number_type": "us_border_crossing_card",
    "tax_id": "123456789",
    "kyc": "pass",
    "onboarding_profile": "kyc_track",
    "merchant_category_code": "5411",
    "merchant_category_code_category": "Grocery Stores, Supermarkets",
    "merchant_category_code_classification": "transferable",
    "sanction_screening": "pass",
    "idv": "pass",
    "liveness_check": "pass",
    "employment_status": "full_time",
    "industry": "adult_entertainment",
    "source_of_funds": "salary",
    "signed_agreements": [
      {
        "type": "user_agreement",
        "region": "us",
        "signed_timestamp": 1603378501286
      }
    ],
    "onboarded_location": "US-FL",
    "salary": "under_3500",
    "savings_and_investments": "under_10000",
    "tx_equivalent_annual_volume": "25k_to_100k",
    "gross_annual_income_amount": "25k_to_100k",
    "expected_usd_equivalent_daily_volume": "between_1001_and_10000",
    "gross_annual_salary_amount": "10000",
    "savings_and_investments_amount": "50000",
    "gross_annual_income": "60000",
    "tx_usd_equivalent_monthly_amount": "10000",
    "tx_usd_equivalent_annual_amount": "10000",
    "investor_category": "restricted",
    "ip_address": "10.132.5.50",
    "appropriateness_test_results": [
      {
        "result": "pass",
        "timestamp": "1985-09-02"
      }
    ],
    "kyc_attempts": 1,
    "citizenship_code": "US",
    "metadata": {},
    "email_screening": "failed",
    "tin_jurisdiction_reason": "working_abroad",
    "additional_tax_residences": [
      {
        "jurisdiction_code": "US-IL"
      }
    ],
    "proof_of_address_coordinates": {
      "latitude": "51.511164",
      "longitude": "-0.083317"
    },
    "w8_ben": {
      "ftin": "AB123456C",
      "ftin_required": true,
      "reference_numbers": "REF-001",
      "treaty_claim": {
        "is_eligible": true,
        "country": "GB",
        "residence_certification": true,
        "income_type": "royalties_other",
        "withholding_rate": "15",
        "article_paragraph": "Article 12(2)"
      }
    },
    "w8_ben_e": {
      "tax_classification": "corporation",
      "ftin": "DE123456789",
      "ftin_required": true,
      "reference_numbers": "REF-002",
      "treaty_claim": {
        "is_eligible": true,
        "country": "DE",
        "residence_certification": true,
        "income_type": "business_profits",
        "withholding_rate": "0",
        "article_paragraph": "Article 7",
        "requirements_certification": true,
        "limitation_on_benefits": "publicly_traded_corporation"
      }
    },
    "mailing_address": {
      "address_one": "10 Downing Street",
      "address_two": "Apt 2",
      "city": "London",
      "state": "England",
      "postal_code": "SW1A 2AA",
      "country": "GB"
    },
    "chamber_of_commerce_number": "12345678",
    "entity_source_of_funds": "operating_revenues",
    "entity_source_of_funds_description": "Grant funding from the EU innovation program",
    "activity_locations": [
      "NL",
      "DE"
    ],
    "entity_sub_type": "trust_llc",
    "declaration_no_effective_control": true,
    "declaration_no_effective_control_at": 1678901234567,
    "declaration_no_foreseeable_changes": true,
    "declaration_no_foreseeable_changes_at": 1678901234567,
    "reason_for_business_relationship": "Cross-border settlement services",
    "expected_annual_volume": "between_100k_and_250k"
  }
}

Changes

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new BUSINESS enum value to the / response property for the response status

    • warning

      added the new INDIVIDUAL enum value to the / response property for the response status

    • warning

      added the new approved enum value to the / response property for the response status

    • warning

      added the new closed enum value to the / response property for the response status

    • warning

      added the new compliance_issue enum value to the / response property for the response status

    • warning

      added the new disabled enum value to the / response property for the response status

    • warning

      added the new divested enum value to the / response property for the response status

    • warning

      added the new locked enum value to the / response property for the response status

    • warning

      added the new pending_approval enum value to the / response property for the response status

    • warning

      added the new rejected enum value to the / response property for the response status

    • warning

      added the new risk_cleared enum value to the / response property for the response status

    • warning

      added the new submitted enum value to the / response property for the response status

    • warning

      added the new user_request enum value to the / response property for the response status

    • warning

      added the new virtual_accounts enum value to the /// response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status