Skip to main content

Get customer details by externalCustomerId

GET 
/customers/by-external-customer-id/:externalCustomerId/customer

Get a single customer's details, filtered by externalCustomerId.

Request​

Path Parameters

    externalCustomerId stringrequired

Responses​

Successful response

Schema
    id uuidrequired
    cmsProjectId stringrequired
    externalCustomerId stringnullablerequired
    riskScore stringnullablerequired

    Possible values: [Low, Medium, High, No risk]

    type stringnullablerequired

    Possible values: [Individual, Company]

    onboardingLevel stringnullablerequired

    Possible values: [Sign-up, AML screening, KYC, Questionaire, Onboarded, Onboarding, KYB, Onboarded]

    status stringnullablerequired

    Possible values: [Active, Rejected, Dormant, To be reviewed, Failed, Escalated, Terminated, No status]

    createdAt date-timerequired
    updatedAt date-timerequired
    createdBy stringrequired
    updatedBy stringrequired
    reason stringnullable
    customerWallets object[]required
  • Array [
    • id uuidrequired
    wallet object required
    anyOf

    string

    blockchainNamespace stringnullablerequired

    Possible values: [tezos, eip155, aptos, polkadot, starknet, cosmos, solana, cardano]

    customerId uuidrequired
    verified booleannullablerequired
    createdAt date-timerequired
    updatedAt date-timerequired
    createdBy stringrequired
    updatedBy stringrequired
    bigData object[]nullable
  • Array [
    • id uuidrequired
    customerId uuidrequired
    wallet stringrequired
    onchainData object required
    anyOf
    error object required
    anyOf
    statusCode numberrequired

    Possible values: [400]

    errorCode stringrequired

    Possible values: [INVALID_ADDRESS]

    message stringrequired

    Possible values: [The address provided isn't a valid address.]

    requestObject objectrequired
    crypto stringnullable

    Possible values: [btc, eth, ltc, bch, xrp, xlm, sys, xdc, doge, dash, zec, trx, etc, bsc]

    Default value: eth

    address stringnullable

    String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet.

    properties object[]nullable

    Optional query parameter to specify properties to include in the response.

  • Array [
    • property stringrequired

    Possible values: [score, entities, flags, currency, new_address, flags_with_category, cluster, first_seen_receiving, first_seen_sending, last_seen_receiving, last_seen_sending, received_amount, sent_amount, number_of_transactions, received_transactions, sent_transactions, balance, balance_fiat, bitrank_counterparty_exposure, entity_counterparty_exposure, flag_counterparty_exposure]

  • ]
    • label stringnullable

    Possible values: <= 255 characters

    Optional string of up to 255 characters for labeling the search.

    transactionsPerPage numbernullable

    Optional parameter to specify the number of transactions per page in the response.

    createdAt date-timerequired
    updatedAt date-timerequired
  • ]
    • scoreChainData object[]nullable
  • Array [
    • id uuidrequired
    customerId uuidrequired
    wallet stringrequired
    onchainData object required
    anyOf
    id uuidrequired
    analysis objectrequired
    assigned objectrequired
    hasResult booleanrequired
    result objectnullable
    score integerrequired

    Possible values: <= 100

    severity stringrequired

    Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]

    details objectrequired
    entity objectnullable
    id integernullable
    name stringrequired
    type string

    Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]

    referenceAddress object required
    anyOf

    string

    aiDetails objectnullable
    entityTypeClassifier object[]required
  • Array [
    • type string

    Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]

    percent numberrequired
  • ]
    • transaction objectnullable
    type stringrequired

    Possible values: [MINING, MIXING, LIGHTNING, CROSS_CHAIN]

    riskAssessment objectrequired
    score integerrequired

    Possible values: >= 1 and <= 100

    severity stringrequired

    Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]

    customRiskAssessment objectnullable
    score integerrequired

    Possible values: >= 1 and <= 100

    severity stringrequired

    Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]

    risks object[]nullable
  • Array [
    • id integerrequired
    type stringrequired

    Possible values: [ENTITY_TYPE, ENTITY_COUNTRY, BEHAVIOR]

    parameters objectrequired
    referenceId integerrequired
    referenceName object
    anyOf

    string

    threshold integerrequired
  • ]
    • incoming objectnullable
    hasResult booleanrequired
    result objectnullable
    score integerrequired

    Possible values: <= 100

    severity stringrequired

    Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]

    details object[]nullable
  • Array [
    • referenceAddress object required
    anyOf

    string

    amount numberrequired
    amountUsd numbernullable
    percentage numberrequired
    name stringrequired
    type object
    anyOf

    string

    Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]

    countries string[]required
    score integerrequired

    Possible values: <= 100

    severity stringrequired

    Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]

    aiDetails objectnullable
    entityTypeClassifier object[]required
  • Array [
    • type string

    Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]

    percent numberrequired
  • ]
  • ]
    • risks object[]nullable
  • Array [
    • setting objectrequired
    id integerrequired
    type stringrequired

    Possible values: [ENTITY_TYPE, ENTITY_COUNTRY, BEHAVIOR]

    parameters objectrequired
    referenceId integerrequired
    referenceName object
    anyOf

    string

    threshold integerrequired
    causes object[]nullable
  • Array [
    • referenceAddress object required
    anyOf

    string

    amount numberrequired
    amountUsd numbernullable
    percentage numberrequired
    name stringrequired
    type object
    anyOf

    string

    Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]

    countries string[]required
    score integerrequired

    Possible values: <= 100

    severity stringrequired

    Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]

    aiDetails objectnullable
    entityTypeClassifier object[]required
  • Array [
    • type string

    Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]

    percent numberrequired
  • ]
  • ]
  • ]
    • outgoing objectnullable
    hasResult booleanrequired
    result objectnullable
    score integerrequired

    Possible values: <= 100

    severity stringrequired

    Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]

    details object[]nullable
  • Array [
    • referenceAddress object required
    anyOf

    string

    amount numberrequired
    amountUsd numbernullable
    percentage numberrequired
    name stringrequired
    type object
    anyOf

    string

    Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]

    countries string[]required
    score integerrequired

    Possible values: <= 100

    severity stringrequired

    Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]

    aiDetails objectnullable
    entityTypeClassifier object[]required
  • Array [
    • type string

    Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]

    percent numberrequired
  • ]
  • ]
    • risks object[]nullable
  • Array [
    • setting objectrequired
    id integerrequired
    type stringrequired

    Possible values: [ENTITY_TYPE, ENTITY_COUNTRY, BEHAVIOR]

    parameters objectrequired
    referenceId integerrequired
    referenceName object
    anyOf

    string

    threshold integerrequired
    causes object[]nullable
  • Array [
    • referenceAddress object required
    anyOf

    string

    amount numberrequired
    amountUsd numbernullable
    percentage numberrequired
    name stringrequired
    type object
    anyOf

    string

    Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]

    countries string[]required
    score integerrequired

    Possible values: <= 100

    severity stringrequired

    Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]

    aiDetails objectnullable
    entityTypeClassifier object[]required
  • Array [
    • type string

    Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]

    percent numberrequired
  • ]
  • ]
  • ]
    • lowestScore integerrequired

    Possible values: <= 100

    requestObject objectrequired
    analysisType stringnullable

    Possible values: [ASSIGNED, INCOMING, OUTGOING, FULL]

    objectType stringnullable

    Possible values: [TRANSACTION, ADDRESS, WALLET]

    objectId stringnullable

    Address or transaction hash, depending on objectType

    blockchain stringnullable

    Possible values: [BITCOIN, BITCOINCASH, LITECOIN, DASH, ETHEREUM, RIPPLE, TEZOS, TRON, BSC, POLYGON, AVALANCHE, BASE, SOLANA]

    coin object nullable

    Coin (Use MAIN according to the docs)

    anyOf

    string

    depth integernullable

    Possible values: >= 1 and <= 100

    createdAt date-timerequired
    updatedAt date-timerequired
  • ]
    • merkleScienceData object[]nullable
  • Array [
    • id uuidrequired
    customerId uuidrequired
    wallet stringrequired
    onchainData object required
    anyOf
    statusCode numbernullable
    identifier stringnullable
    blockchain integernullable

    Possible values: <= 123

    blockchain_verbose stringnullable

    Possible values: [Bitcoin, Ethereum, Litecoin, BitcoinCash, Ripple, Dogecoin, Zilliqa, BinanceSmartChain, Polygon, Tron, Cardano, Polkadot, Stellar, Hedera, Cronos, Optimism, Arbitrum, Fantom, Monero, Cosmos, Zcash, EthereumClassic, Dash, Solana, AvalancheC_Chain, Verge, BitcoinGold, Algorand, Acala, Akash, Arweave, Ardor, Ark, Astar, Band, BinanceNative, Celo, Chiliz, Nervos, CronosNative, Digibyte, Multiversx, Enjin, Eos, EthereumPow, FetchAI, Filecoin, Flow, Flare, Moonbeam, Helium, ICP, Icon, Injective, IOTA, IoTex, Iris, Kava, Kadena, Klaytn, Komodo, Kusama, Lisk, Terra, Mina, Moonriver, Nano, Near, Neo3, Oasys, One, Ontology, Osmosis, Polymesh, QTUM, Oasis, Thorchain, Ravencoin, Siacoin, Shiden, Songbird, Stratis, Stacks, SUI, zkSync, Theta, Tomo, VeChain, Waves, Wax, WEMIX, WaltonChain, Chia, Tezos, Zcoin, Celestia, Neutron, Avalanche_P, Sei, Avalanche_X, Aztec, Bittensor, Casper, Deso, Juno, PocketNetwork, Ronin, Vara, XPLA, Archway, Axelar, Dymension, Starknet, Orai, Lukso, bitsCrunch, Reef, ImmutablezkEVM, BaseProtocol, ArbitrumNova, Canto, MetisDAO, Aptos, Bitcoin Cash, Binance Smart Chain, Ethereum Classic, Avalanche C-Chain, Bitcoin Gold, Binance Native, Cronos Native, Ethereum Pow, Fetch AI, Avalanche-P, Avalanche-X, Pocket Network, Immutable zkEVM, Base Protocol, Arbitrum Nova]

    customer_id uuidnullable
    type numbernullable
    type_verbose stringnullable
    total_incoming_value stringnullable
    total_incoming_value_usd stringnullable
    total_outgoing_value stringnullable
    total_outgoing_value_usd stringnullable
    balance numbernullable
    earliest_transaction_time stringnullable
    latest_transaction_time stringnullable
    risk_level integernullable

    Possible values: <= 5

    risk_level_verbose stringnullable

    Possible values: [No Risk Detected, Info, Caution, Medium, High, Critical]

    created_at stringnullable
    updated_at stringnullable
    originator object[]nullable
  • Array [
    • tag_type_verbose stringrequired
    tag_subtype_verbose stringrequired
    tag_name_verbose stringrequired
    total_value_usd numberrequired
    exposure_type stringrequired
  • ]
    • beneficiary object[]nullable
  • Array [
    • object
  • ]
    • tags objectnullable
    owner objectrequired
    tag_type_verbose stringnullable
    tag_subtype_verbose stringnullable
    tag_name_verbose stringnullable
    user objectrequired
    tag_type_verbose stringnullable
    tag_subtype_verbose stringnullable
    tag_name_verbose stringnullable
    custom_tags string[]nullable
    digital_assets object[]nullable
  • Array [
    • name stringnullable
    symbol stringnullable
  • ]
    • requestObject objectrequired
    identifier stringrequired
    blockchain stringrequired

    Possible values: [0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123]

    customer_id uuidrequired
    type numberrequired

    Possible values: [1, 2]

    show_alerts booleannullable
    custom_tags string[]nullable
    createdAt date-timerequired
    updatedAt date-timerequired
  • ]
    • chainalysisData object[]nullable
  • Array [
    • id uuidrequired
    customerId uuidrequired
    wallet stringrequired
    onchainData object required
    anyOf
    address stringrequired
    risk stringrequired

    Possible values: [Severe, High, Medium, Low]

    riskReason stringnullable
    cluster objectnullable
    name stringrequired
    category stringrequired
    addressType stringrequired

    Possible values: [PRIVATE_WALLET, LIQUIDITY_POOL, SERVICE_PROVIDER]

    addressIdentifications object[]required
  • Array [
    • name stringrequired
    address stringrequired
    category stringrequired
    description stringrequired
    url stringnullable
    createdAt numberrequired
  • ]
    • exposures object[]nullable
  • Array [
    • category stringrequired
    value numberrequired
    exposureType stringrequired

    Possible values: [direct, indirect]

    direction stringrequired

    Possible values: [both_directions]

  • ]
    • triggers object[]nullable
  • Array [
    • category stringrequired
    percentage numberrequired
    message stringrequired
    ruleTriggered objectnullable
    risk stringrequired
    minThreshold numberrequired
    maxThreshold numberrequired
    exposureType stringrequired

    Possible values: [direct, indirect]

    direction stringrequired

    Possible values: [both_directions]

  • ]
    • status stringrequired

    Possible values: [COMPLETE]

    poolMetadata objectnullable
    fees numbernullable
    tokens string[]required
    requestObject objectrequired
    address stringrequired
    createdAt date-timerequired
    updatedAt date-timerequired
  • ]
  • ]
    • customerClaims object[]required
  • Array [
    • id uuidrequired
    customerId uuidrequired
    sub stringnullablerequired
    name stringnullablerequired
    givenName stringnullablerequired
    familyName stringnullablerequired
    middleName stringnullablerequired
    nickname stringnullablerequired
    preferredUsername stringnullablerequired
    profile stringnullablerequired
    picture stringnullablerequired
    pictureBase64 stringnullablerequired
    website stringnullablerequired
    gender stringnullablerequired
    birthdate date-timenullable
    zoneinfo stringnullablerequired
    locale stringnullablerequired
    countryOfResidence stringnullable

    Possible values: [AFG, ALB, DZA, ASM, AND, AGO, AIA, ATA, ATG, ARG, ARM, ABW, AUS, AUT, AZE, BHS, BHR, BGD, BRB, BLR, BEL, BLZ, BEN, BMU, BTN, BOL, BES, BIH, BWA, BVT, BRA, IOT, BRN, BGR, BFA, BDI, CPV, KHM, CMR, CAN, CYM, CAF, TCD, CHL, CHN, CXR, CCK, COL, COM, COD, COG, COK, CRI, HRV, CUB, CUW, CYP, CZE, CIV, DNK, DJI, DMA, DOM, ECU, EGY, SLV, GNQ, ERI, EST, SWZ, ETH, FLK, FRO, FJI, FIN, FRA, GUF, PYF, ATF, GAB, GMB, GEO, DEU, GHA, GIB, GRC, GRL, GRD, GLP, GUM, GTM, GGY, GIN, GNB, GUY, HTI, HMD, VAT, HND, HKG, HUN, ISL, IND, IDN, IRN, IRQ, IRL, IMN, ISR, ITA, JAM, JPN, JEY, JOR, KAZ, KEN, KIR, PRK, KOR, KWT, KGZ, LAO, LVA, LBN, LSO, LBR, LBY, LIE, LTU, LUX, MAC, MDG, MWI, MYS, MDV, MLI, MLT, MHL, MTQ, MRT, MUS, MYT, MEX, FSM, MDA, MCO, MNG, MNE, MSR, MAR, MOZ, MMR, NAM, NRU, NPL, NLD, NCL, NZL, NIC, NER, NGA, NIU, NFK, MNP, NOR, OMN, PAK, PLW, PSE, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, PRI, QAT, MKD, ROU, RUS, RWA, REU, BLM, SHN, KNA, LCA, MAF, SPM, VCT, WSM, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SXM, SVK, SVN, SLB, SOM, ZAF, SGS, SSD, ESP, LKA, SDN, SUR, SJM, SWE, CHE, SYR, TWN, TJK, TZA, THA, TLS, TGO, TKL, TON, TTO, TUN, TUR, TKM, TCA, TUV, UGA, UKR, ARE, GBR, UMI, USA, URY, UZB, VUT, VEN, VNM, VGB, VIR, WLF, ESH, YEM, ZMB, ZWE, ALA, ANT, XKX]

    Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)

    nationality stringnullable

    Possible values: [AFG, ALB, DZA, ASM, AND, AGO, AIA, ATA, ATG, ARG, ARM, ABW, AUS, AUT, AZE, BHS, BHR, BGD, BRB, BLR, BEL, BLZ, BEN, BMU, BTN, BOL, BES, BIH, BWA, BVT, BRA, IOT, BRN, BGR, BFA, BDI, CPV, KHM, CMR, CAN, CYM, CAF, TCD, CHL, CHN, CXR, CCK, COL, COM, COD, COG, COK, CRI, HRV, CUB, CUW, CYP, CZE, CIV, DNK, DJI, DMA, DOM, ECU, EGY, SLV, GNQ, ERI, EST, SWZ, ETH, FLK, FRO, FJI, FIN, FRA, GUF, PYF, ATF, GAB, GMB, GEO, DEU, GHA, GIB, GRC, GRL, GRD, GLP, GUM, GTM, GGY, GIN, GNB, GUY, HTI, HMD, VAT, HND, HKG, HUN, ISL, IND, IDN, IRN, IRQ, IRL, IMN, ISR, ITA, JAM, JPN, JEY, JOR, KAZ, KEN, KIR, PRK, KOR, KWT, KGZ, LAO, LVA, LBN, LSO, LBR, LBY, LIE, LTU, LUX, MAC, MDG, MWI, MYS, MDV, MLI, MLT, MHL, MTQ, MRT, MUS, MYT, MEX, FSM, MDA, MCO, MNG, MNE, MSR, MAR, MOZ, MMR, NAM, NRU, NPL, NLD, NCL, NZL, NIC, NER, NGA, NIU, NFK, MNP, NOR, OMN, PAK, PLW, PSE, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, PRI, QAT, MKD, ROU, RUS, RWA, REU, BLM, SHN, KNA, LCA, MAF, SPM, VCT, WSM, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SXM, SVK, SVN, SLB, SOM, ZAF, SGS, SSD, ESP, LKA, SDN, SUR, SJM, SWE, CHE, SYR, TWN, TJK, TZA, THA, TLS, TGO, TKL, TON, TTO, TUN, TUR, TKM, TCA, TUV, UGA, UKR, ARE, GBR, UMI, USA, URY, UZB, VUT, VEN, VNM, VGB, VIR, WLF, ESH, YEM, ZMB, ZWE, ALA, ANT, XKX]

    Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)

    updatedAt date-timenullable
    createdAt date-timenullablerequired
    createdBy stringrequired
    updatedBy stringrequired
  • ]
    • customerDids object[]required
  • Array [
    • id uuidrequired
    did stringrequired
    customerId uuidrequired
    createdAt date-timerequired
    updatedAt date-timerequired
    createdBy stringrequired
    updatedBy stringrequired
  • ]
    • customerAddresses object[]required
  • Array [
    • id uuidrequired
    customerId uuidrequired
    formatted stringnullablerequired
    street stringnullablerequired
    city stringnullablerequired
    state stringnullablerequired
    region stringnullablerequired
    postalCode stringnullablerequired
    locality stringnullablerequired
    country stringnullable

    Possible values: [AFG, ALB, DZA, ASM, AND, AGO, AIA, ATA, ATG, ARG, ARM, ABW, AUS, AUT, AZE, BHS, BHR, BGD, BRB, BLR, BEL, BLZ, BEN, BMU, BTN, BOL, BES, BIH, BWA, BVT, BRA, IOT, BRN, BGR, BFA, BDI, CPV, KHM, CMR, CAN, CYM, CAF, TCD, CHL, CHN, CXR, CCK, COL, COM, COD, COG, COK, CRI, HRV, CUB, CUW, CYP, CZE, CIV, DNK, DJI, DMA, DOM, ECU, EGY, SLV, GNQ, ERI, EST, SWZ, ETH, FLK, FRO, FJI, FIN, FRA, GUF, PYF, ATF, GAB, GMB, GEO, DEU, GHA, GIB, GRC, GRL, GRD, GLP, GUM, GTM, GGY, GIN, GNB, GUY, HTI, HMD, VAT, HND, HKG, HUN, ISL, IND, IDN, IRN, IRQ, IRL, IMN, ISR, ITA, JAM, JPN, JEY, JOR, KAZ, KEN, KIR, PRK, KOR, KWT, KGZ, LAO, LVA, LBN, LSO, LBR, LBY, LIE, LTU, LUX, MAC, MDG, MWI, MYS, MDV, MLI, MLT, MHL, MTQ, MRT, MUS, MYT, MEX, FSM, MDA, MCO, MNG, MNE, MSR, MAR, MOZ, MMR, NAM, NRU, NPL, NLD, NCL, NZL, NIC, NER, NGA, NIU, NFK, MNP, NOR, OMN, PAK, PLW, PSE, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, PRI, QAT, MKD, ROU, RUS, RWA, REU, BLM, SHN, KNA, LCA, MAF, SPM, VCT, WSM, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SXM, SVK, SVN, SLB, SOM, ZAF, SGS, SSD, ESP, LKA, SDN, SUR, SJM, SWE, CHE, SYR, TWN, TJK, TZA, THA, TLS, TGO, TKL, TON, TTO, TUN, TUR, TKM, TCA, TUV, UGA, UKR, ARE, GBR, UMI, USA, URY, UZB, VUT, VEN, VNM, VGB, VIR, WLF, ESH, YEM, ZMB, ZWE, ALA, ANT, XKX]

    Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)

    createdAt date-timerequired
    updatedAt date-timerequired
    createdBy stringrequired
    updatedBy stringrequired
  • ]
    • customerIps object[]required
  • Array [
    • id uuidrequired
    customerId uuidrequired
    ipAddress stringrequired
    createdAt date-timerequired
    updatedAt date-timerequired
    createdBy stringrequired
    updatedBy stringrequired
    ipQualityScoreData object[]nullable
  • Array [
    • id uuidrequired
    customerId uuidrequired
    scoreAnalysis object required
    anyOf
    error object required
    anyOf
    success booleanrequired
    message stringrequired

    Possible values: [Invalid or unauthorized key. Please check the API key and try again.]

    request_id stringrequired
    requestObject objectrequired
    apiKey stringnullable
    ipValue stringnullable
    userEmail stringnullable
    userPhoneNumber stringnullable
    ipValue stringnullablerequired
    userEmail stringnullablerequired
    userPhoneNumber stringnullablerequired
    createdAt date-timerequired
    updatedAt date-timerequired
  • ]
  • ]
    • customerPhones object[]required
  • Array [
    • id uuidrequired
    customerId uuidrequired
    phoneNumber stringrequired
    verified booleannullablerequired
    createdAt date-timerequired
    updatedAt date-timerequired
    createdBy stringrequired
    updatedBy stringrequired
    ipQualityScoreData object[]nullable
  • Array [
    • id uuidrequired
    customerId uuidrequired
    scoreAnalysis object required
    anyOf
    error object required
    anyOf
    success booleanrequired
    message stringrequired

    Possible values: [Invalid or unauthorized key. Please check the API key and try again.]

    request_id stringrequired
    requestObject objectrequired
    apiKey stringnullable
    ipValue stringnullable
    userEmail stringnullable
    userPhoneNumber stringnullable
    ipValue stringnullablerequired
    userEmail stringnullablerequired
    userPhoneNumber stringnullablerequired
    createdAt date-timerequired
    updatedAt date-timerequired
  • ]
  • ]
    • customerEmails object[]required
  • Array [
    • id uuidrequired
    customerId uuidrequired
    email stringrequired
    verified booleannullablerequired
    createdAt date-timerequired
    updatedAt date-timerequired
    createdBy stringrequired
    updatedBy stringrequired
    ipQualityScoreData object[]nullable
  • Array [
    • id uuidrequired
    customerId uuidrequired
    scoreAnalysis object required
    anyOf
    error object required
    anyOf
    success booleanrequired
    message stringrequired

    Possible values: [Invalid or unauthorized key. Please check the API key and try again.]

    request_id stringrequired
    requestObject objectrequired
    apiKey stringnullable
    ipValue stringnullable
    userEmail stringnullable
    userPhoneNumber stringnullable
    ipValue stringnullablerequired
    userEmail stringnullablerequired
    userPhoneNumber stringnullablerequired
    createdAt date-timerequired
    updatedAt date-timerequired
  • ]
  • ]
    • customerContactInformation object[]nullable
  • Array [
    • id uuidrequired
    customerId uuidrequired
    information objectrequired
    email email
    phone string

    Possible values: >= 4 characters

    twitter string
    discord string
    telegram string
    createdAt date-timerequired
    updatedAt date-timerequired
    createdBy stringrequired
    updatedBy stringrequired
  • ]
    • customerDuplicates object[]nullable
  • Array [
    • id uuidrequired
    customerIdLeft uuidrequired
    customerIdRight uuidrequired
    description stringnullablerequired
    customerInfoLeft stringnullablerequired
    customerInfoRight stringnullablerequired
    matchedFields stringnullablerequired
    exactMatch booleannullablerequired
    alertId uuidnullablerequired
    createdAt date-timerequired
    updatedAt date-timerequired
  • ]
    • synapsSessions object[]required
  • Array [
    • id uuidrequired
    synapsSessionId stringrequired
    customerId uuidrequired
    sessionData objectrequired
    app objectrequired
    name stringrequired
    id stringrequired
    session objectrequired
    alias stringrequired
    id stringrequired
    status stringrequired

    Possible values: [APPROVED, SUBMISSION_REQUIRED, RESUBMISSION_REQUIRED, REJECTED, PENDING_VERIFICATION]

    sandbox booleanrequired
    createdAt date-timerequired
    updatedAt date-timerequired
    synapsSteps object[]required
  • Array [
    • id uuidrequired
    synapsStepId stringrequired
    customerId uuidrequired
    sessionId uuidrequired
    stepData objectrequired
    id stringrequired
    type stringrequired

    Possible values: [ID_DOCUMENT, LIVENESS, PROOF_OF_ADDRESS, PHONE, EMAIL]

    metadata objectrequired
    ip stringrequired
    user_agent stringrequired
    platform stringrequired
    browser_name stringrequired
    browser_version stringrequired
    device stringrequired
    customer_language stringrequired
    status stringrequired

    Possible values: [APPROVED, SUBMISSION_REQUIRED, RESUBMISSION_REQUIRED, REJECTED, PENDING_VERIFICATION]

    reason objectnullable
    code stringrequired

    Possible values: [FORGED_REJECTION, DOCUMENT_HIDDEN, BAD_ENVIRONMENT, BLACK_WHITE_PICTURE, BAD_QUALITY, DOCUMENT_COMPLIANCE, IDENTITY_DOCUMENT_EXPIRED, DOCUMENT_INVALID_FRONT_SIDE, DOCUMENT_INVALID_BACK_SIDE, IDENTITY_DOCUMENT_DOB_DATE_MINOR, RESTRICTED_NATIONALITY_TYPE, DUPLICATE_USER, ``]

    message objectrequired
    original stringrequired
    translated stringrequired
    document object nullable
    anyOf
    country stringrequired
    type stringrequired

    Possible values: [PASSPORT, NATIONAL_ID, DRIVER_LICENSE, RESIDENT_PERMIT, ``]

    fields objectrequired
    firstname stringrequired
    lastname stringrequired
    birth_date stringrequired
    document_expiration stringrequired
    document_number stringrequired
    nationality stringrequired
    files objectrequired
    front objectnullable
    url stringrequired
    type stringrequired
    size numberrequired
    base64 stringnullable
    back objectnullable
    url stringrequired
    type stringrequired
    size numberrequired
    base64 stringnullable
    face objectnullable
    url stringrequired
    type stringrequired
    size numberrequired
    base64 stringnullable
    original_files objectrequired
    front objectnullable
    url stringrequired
    type stringrequired
    size numberrequired
    base64 stringnullable
    back objectnullable
    url stringrequired
    type stringrequired
    size numberrequired
    base64 stringnullable
    verification object nullable
    anyOf
    liveness objectrequired
    file objectrequired
    url stringrequired
    type stringrequired
    size numberrequired
    base64 stringnullable
    createdAt date-timerequired
    updatedAt date-timerequired
  • ]
  • ]
    • audits object[]
  • Array [
    • timestamp date-timerequired
    action stringrequired

    Possible values: [create, update, attach, detach, duplicate]

    author stringnullable
    record objectrequired
    id uuid
    cmsProjectId string
    externalCustomerId stringnullable
    riskScore stringnullable

    Possible values: [Low, Medium, High, No risk]

    type stringnullable

    Possible values: [Individual, Company]

    onboardingLevel stringnullable

    Possible values: [Sign-up, AML screening, KYC, Questionaire, Onboarded, Onboarding, KYB, Onboarded]

    status stringnullable

    Possible values: [Active, Rejected, Dormant, To be reviewed, Failed, Escalated, Terminated, No status]

    createdAt date-time
    updatedAt date-time
    createdBy string
    updatedBy string
    reason stringnullable
  • ]
    • complyAdvantageSearches object[]nullable
  • Array [
    • id uuidrequired
    customerId uuidrequired
    searchId numbernullablerequired
    searchRef stringnullablerequired
    searchResult objectrequired
    client_ref stringrequired
    id numberrequired
    ref stringrequired
    searcher_id numberrequired
    assignee_id numberrequired
    filters object
    types string[]nullable

    Possible values: [sanction, warning, fitness-probity, pep, pep-class-1, pep-class-2, pep-class-3, pep-class-4, adverse-media, adverse-media-financial-crime, adverse-media-violent-crime, adverse-media-sexual-crime, adverse-media-terrorism, adverse-media-fraud, adverse-media-narcotics, adverse-media-general, adverse-media-v2-property, adverse-media-v2-financial-aml-cft, adverse-media-v2-fraud-linked, adverse-media-v2-narcotics-aml-cft, adverse-media-v2-violence-aml-cft, adverse-media-v2-terrorism, adverse-media-v2-cybercrime, adverse-media-v2-general-aml-cft, adverse-media-v2-regulatory, adverse-media-v2-financial-difficulty, adverse-media-v2-violence-non-aml-cft, adverse-media-v2-other-financial, adverse-media-v2-other-serious, adverse-media-v2-other-minor]

    birth_year numbernullable
    remove_deceased numbernullable

    Possible values: <= 1

    entity_type stringnullable

    Possible values: [person, company, organisation, vessel, aircraft]

    country_codes string[]nullable

    Possible values: [AN, XK, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, VG, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VI, WF, EH, YE, ZM, ZW]

    match_status stringrequired

    Possible values: [unknown, no_match, potential_match, false_positive, true_positive, true_positive_approve, true_positive_reject]

    risk_level stringrequired

    Possible values: [low, medium, high, unknown]

    search_term stringrequired
    submitted_term stringrequired
    total_hits numberrequired
    total_matches numberrequired
    total_blacklist_hits numberrequired
    created_at date-timerequired
    updated_at date-timerequired
    tags object[]
    labels undefined[]required
    limit numberrequired
    offset numberrequired
    searcher object
    id numberrequired
    email emailrequired
    name stringrequired
    phone stringrequired
    created_at date-timerequired
    user_is_active booleanrequired
    assignee object
    id numberrequired
    email emailrequired
    name stringrequired
    phone stringrequired
    created_at date-timerequired
    user_is_active booleanrequired
    hits object[]
  • Array [
    • doc objectrequired
    id stringrequired
    last_updated_utc date-timerequired
    created_utc date-timerequired
    fields object[]
  • Array [
    • name stringrequired
    source string
    value stringrequired
    locale string
    tag string
  • ]
    • types string[]required

    Possible values: [sanction, warning, fitness-probity, pep, pep-class-1, pep-class-2, pep-class-3, pep-class-4, adverse-media, adverse-media-financial-crime, adverse-media-violent-crime, adverse-media-sexual-crime, adverse-media-terrorism, adverse-media-fraud, adverse-media-narcotics, adverse-media-general, adverse-media-v2-property, adverse-media-v2-financial-aml-cft, adverse-media-v2-fraud-linked, adverse-media-v2-narcotics-aml-cft, adverse-media-v2-violence-aml-cft, adverse-media-v2-terrorism, adverse-media-v2-cybercrime, adverse-media-v2-general-aml-cft, adverse-media-v2-regulatory, adverse-media-v2-financial-difficulty, adverse-media-v2-violence-non-aml-cft, adverse-media-v2-other-financial, adverse-media-v2-other-serious, adverse-media-v2-other-minor]

    name stringrequired
    entity_type stringrequired

    Possible values: [person, company, organisation, vessel, aircraft]

    aka object[]required
  • Array [
    • name stringrequired
  • ]
    • associates object[]
  • Array [
    • association stringrequired
    name stringrequired
  • ]
    • sources string[]required
    keywords undefined[]required
    media object[]
  • Array [
    • date date-time
    snippet stringrequired
    title stringrequired
    url urirequired
  • ]
    • source_notes
    match_types string[]required
    match_types_details object[]required
  • Array [
    • aml_types string[]required
    matching_name stringrequired
    name_matches object[]required
  • Array [
    • match_types string[]required
    query_term stringrequired
  • ]
    • secondary_matches undefined[]required
    sources string[]required
  • ]
    • match_status stringrequired
    is_whitelisted booleanrequired
    score numberrequired
  • ]
    • blacklist_hits undefined[]
    searchEntities object[]nullable
  • Array [
    • id stringrequired
    last_updated_utc date-timerequired
    created_utc date-timerequired
    key_information objectnullable
    name stringrequired
    entity_type stringrequired

    Possible values: [person, company, organisation, vessel, aircraft]

    types string[]nullable

    Possible values: [sanction, warning, fitness-probity, pep, pep-class-1, pep-class-2, pep-class-3, pep-class-4, adverse-media, adverse-media-financial-crime, adverse-media-violent-crime, adverse-media-sexual-crime, adverse-media-terrorism, adverse-media-fraud, adverse-media-narcotics, adverse-media-general, adverse-media-v2-property, adverse-media-v2-financial-aml-cft, adverse-media-v2-fraud-linked, adverse-media-v2-narcotics-aml-cft, adverse-media-v2-violence-aml-cft, adverse-media-v2-terrorism, adverse-media-v2-cybercrime, adverse-media-v2-general-aml-cft, adverse-media-v2-regulatory, adverse-media-v2-financial-difficulty, adverse-media-v2-violence-non-aml-cft, adverse-media-v2-other-financial, adverse-media-v2-other-serious, adverse-media-v2-other-minor]

    grouped_types object[]nullable
  • Array [
    • type stringrequired

    Possible values: [sanction, warning, fitness-probity, pep, pep-class-1, pep-class-2, pep-class-3, pep-class-4, adverse-media, adverse-media-financial-crime, adverse-media-violent-crime, adverse-media-sexual-crime, adverse-media-terrorism, adverse-media-fraud, adverse-media-narcotics, adverse-media-general, adverse-media-v2-property, adverse-media-v2-financial-aml-cft, adverse-media-v2-fraud-linked, adverse-media-v2-narcotics-aml-cft, adverse-media-v2-violence-aml-cft, adverse-media-v2-terrorism, adverse-media-v2-cybercrime, adverse-media-v2-general-aml-cft, adverse-media-v2-regulatory, adverse-media-v2-financial-difficulty, adverse-media-v2-violence-non-aml-cft, adverse-media-v2-other-financial, adverse-media-v2-other-serious, adverse-media-v2-other-minor]

  • ]
    • match_types string[]nullable
    sources string[]nullable
    source_notes nullable
    aka object[]nullable
  • Array [
    • name stringrequired
  • ]
    • date_of_birth stringnullable
    dates_of_birth string[]nullable
    match_status stringnullable

    Possible values: [unknown, no_match, potential_match, false_positive, true_positive, true_positive_approve, true_positive_reject]

    risk_level stringnullable

    Possible values: [low, medium, high, unknown]

    is_whitelisted booleannullable
    age numbernullable
    death_age nullable
    date_of_death nullable
    primary_country nullable
    country_names stringnullable
    designation stringnullable
    associates object[]nullable
  • Array [
    • association stringrequired
    name stringrequired
  • ]
    • uncategorized objectnullable
    keywords undefined[]nullable
    media object[]nullable
  • Array [
    • date date-time
    snippet stringrequired
    title stringrequired
    url urirequired
  • ]
    • assets undefined[]nullable
    match_types string[]nullable
    related undefined[]nullable
    fields undefined[]nullable
    full_listing objectnullable
    anyOf
    navigation objectnullable
    next nullable
    previous nullable
  • ]
    • requestData objectrequired
    search_term stringrequired

    represents name of the entity

    client_ref stringrequired

    Your reference for this person/entity for which you are searching. Used for tracking searches and auto-whitelisting recurring results

    search_profile stringnullable

    The Profile ID of a search profile that can be retrieved from the UI

    fuzziness numbernullable

    Possible values: <= 1

    determines how closely the returned results must match the supplied name. Overridden by exact_match

    offset numbernullable

    match results from the database, starting form the offset value

    limit numbernullable

    math results from the database, taking up this many matches each search

    filters object

    specify filters within the search to narrow down the results

    types string[]nullable

    Possible values: [sanction, warning, fitness-probity, pep, pep-class-1, pep-class-2, pep-class-3, pep-class-4, adverse-media, adverse-media-financial-crime, adverse-media-violent-crime, adverse-media-sexual-crime, adverse-media-terrorism, adverse-media-fraud, adverse-media-narcotics, adverse-media-general, adverse-media-v2-property, adverse-media-v2-financial-aml-cft, adverse-media-v2-fraud-linked, adverse-media-v2-narcotics-aml-cft, adverse-media-v2-violence-aml-cft, adverse-media-v2-terrorism, adverse-media-v2-cybercrime, adverse-media-v2-general-aml-cft, adverse-media-v2-regulatory, adverse-media-v2-financial-difficulty, adverse-media-v2-violence-non-aml-cft, adverse-media-v2-other-financial, adverse-media-v2-other-serious, adverse-media-v2-other-minor]

    birth_year numbernullable
    remove_deceased numbernullable

    Possible values: <= 1

    entity_type stringnullable

    Possible values: [person, company, organisation, vessel, aircraft]

    country_codes string[]nullable

    Possible values: [AN, XK, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, VG, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VI, WF, EH, YE, ZM, ZW]

    tags object[]nullable

    name => value pairs, to search later using defined tags here

    share_url numbernullable

    Possible values: <= 1

    include a shareable URL to access search publicly

    exact_match booleannullable

    Exact match disables all standard and optional matching behaviours (Honorifics, affixes, initials, glued name, name variation, equivalent names, extra words in entity,...) 0% fuzziness disables 1 letter typo matching but keeps all other matching behaviours (standard and optional)

    executionId stringrequired
    alertId uuidnullablerequired
    isMonitored booleannullablerequired
    createdAt date-timerequired
    updatedAt date-timerequired
  • ]
Loading...