Skip to content
Peritus
DocsSign up
Start

Quickstart

Make a first call and read its answer, in four steps.

  1. Step 1

    Sign up

    Create an account in the console. It mails a code that verifies your address.

    Sign up
  2. Step 2

    Create a key

    The console's First call screen creates a key and shows it once. A key looks like wck_live_<prefix>_<secret>. Keep it in an environment variable, never in a page or a shared file.

    Open First call
  3. Step 3

    Make a first call

    Send a question in plain words to POST /v1/ask. Set PERITUS_BASE to the API's address and PERITUS_API_KEY to your key.

    Request · curl
    curl "$PERITUS_BASE/v1/ask" \
  -H "Authorization: Bearer $PERITUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"Is OFAC UID 3751 sanctioned?","mode":"standard"}'
  4. Step 4

    Read its answer

    status says whether it answered. Each sentence of answer cites the items it comes from, and each item carries its source, tier, and two times.

    Sample responseGET /v1/samples/ask
    status · answeredmode · standard
    1. MOA NICKEL SA is listed on SDN List (OFAC Sanctions List Service (SDN and Consolidated non-SDN lists)).Cites item 1
    2. MOA NICKEL SA is listed under program CUBA on SDN List.Cites item 2
    3. MOA NICKEL SA is listed under program CUBA-EO14404 on SDN List.Cites item 3

    MOA NICKEL SA

    ent_06GR5VVHPDW2Q1HYD75X1W4YNM · org · sanctions.listing_status

    Tier verifiedClaim type fact
    list
    SDN List
    status
    listed
    measures
    Block
    legal_bases
    Cuban Assets Control Regulations (CACR)Executive Order 14404 (Cuba)
    SourceOFAC Sanctions List Service (SDN and Consolidated non-SDN lists)(terms, opens in a new tab)
    Valid timeFrom 1995-05-23, no end dateDay precision
    Recorded time2026-10-28 14:33 UTCWhen Peritus knew it
    Item 1 of 3The whole sample
NextReading a response