DocuClipper logo
Docs
Integrations

Test the API Free with a Sandbox Key

Use your free dcp_test_ key to list DocuClipper's sample bank statements, create jobs on them and read transactions and verification results, with no pages used.

Last updated

Every API account comes with a test key: a key that starts with dcp_test_. It works without limits on a set of sample bank statements we provide, and it never uses pages. Use it to build and test your integration end to end before you go live.

Create a test key in your DocuClipper developer console and copy it. Send it like any other key:

Authorization: Bearer dcp_test_YourTestKey

1. List the sample statements

curl -s https://www.docuclipper.com/api/v1/agent/sandbox/samples \
  -H "Authorization: Bearer dcp_test_YourTestKey"

Each sample has a documentId, a name and its number of pages.

2. Create a job on a sample

curl -s -X POST https://www.docuclipper.com/api/v1/agent/jobs \
  -H "Authorization: Bearer dcp_test_YourTestKey" \
  -H "Content-Type: application/json" \
  -d '{"documents":[<documentId>]}'

The job is finished when the call returns: there is nothing to wait for and no webhook to set up for samples.

3. Read the results

Every read endpoint works on a sample, exactly as it does on your own statements:

  • GET /api/v1/agent/documents/<documentId>: the document, its verification verdict and its statement periods.
  • GET /api/v1/agent/documents/<documentId>/transactions: every transaction (date, description, amount, balance, account, page) plus the verification verdict. Add ?format=csv for a CSV download.
  • GET /api/v1/agent/documents/<documentId>/data: the full structured result.

The verification.status field is verified, needs_review or unverifiable. Write the branch your product takes for each one now, against the samples: the verification reference lists every field.

What a test key cannot do

A test key only reads the sample statements. Uploading a file with a test key is refused with a message that says so. To convert your own statements, add a card in your developer console for 50 free live pages and use a live key (it starts with dcp_). The quickstart shows the same three steps with a live key and an upload.