Quickstart

Zero to your first answered request, against the safe sandbox. New to the domain? Start with Concepts. Using an AI tool? Hand it the agent prompt instead.

1. 1

   Install the CLI

   The Reqport CLI (binary qp) is how you discover, read, and answer requests.

   npx @reqport/cli@latest --help
   # or install globally:
   npm i -g @reqport/cli

2. 2

   Authenticate against the sandbox

   Opens a browser where an org admin approves and a per-environment API key is minted for the CLI. No secret is pasted by hand.

   qp login --env sandbox

3. 3

   Verify

   Confirm the CLI is paired and see who you are on the network.

   qp doctor
   qp whoami

4. 4

   Discover requests addressed to you

   The sandbox is seeded with synthetic requests to answer.

   qp --env sandbox requests list

5. 5

   Read one

   Request content is decrypted only inside the TEE bound to your org.

   qp --env sandbox requests show <REQUEST_ID>

6. 6

   Answer it

   The response shape depends on the exchange contract (see the catalogue). A business-relationship check is a yes/no; a transaction-history request is a camt.053-CA statement.

   qp --env sandbox respond <REQUEST_ID> --has-relationship true
   # or, for a statement:
   qp --env sandbox respond <REQUEST_ID> --statement statement.json

7. 7

   Go live

   Once the loop works in the sandbox, switch to prod. (Prefer raw HTTP? Use your key against the responder API; see the reference below.)

   qp --env prod requests list