Agency API v1

BindRabbit

API Documentation

Agency API

Read intake documents, extracted field data, and form submissions for your agency via a simple, authenticated REST API.

Looking for the embed widget? View Finance Builder Dropzone API →

Live

Version 1.0

JSON · HTTPS

Authentication

Every request must include an Authorization header containing your Agency API key.

Authorization

<agency_api_key>

Your Agency API key, generated in Agency Settings. Passed as-is; hashed with SHA-256 server-side.

Generate an Agency API key in Agency Settings → API Keys. The key is shown once on creation — store it securely.

Example Request Header

Shell

curl https://platform.bindrabbit.com/api/v1/intake_documents \
    -H "Authorization: <your_agency_api_key>"

Security Note Never expose your API keys client-side. All requests should originate from your server. Keys are non-recoverable once generated — if lost, delete the key and generate a new one.

Endpoints

Click an endpoint to expand request and response details.

GET /api/v1/intake_documents List Intake Documents ›

Returns all intake documents for your agency, ordered newest first. Only documents belonging to your agency are returned.

Headers

Header	Required	Description
Authorization	Required	Your Agency API key (no prefix)

Response

200

JSON array of intake document objects.

JSON

[
  {
    "id": 42,
    "file_name": "acord_125.pdf",
    "status": "approved",
    "source_channel": "email",
    "received_from": "broker@example.com",
    "form_template": "ACORD 25",
    "fields": {
      "insured_name": {
        "label": "Insured Name",
        "value": "ACME Corp",
        "confidence": 0.97,
        "corrected": false
      }
    },
    "form_submission": {
      "id": 7,
      "status": "signed",
      "api_url": "/api/v1/form_submissions/7"
    },
    "created_at": "2026-06-01T10:00:00.000Z",
    "reviewed_at": null,
    "delivered_at": null
  }
]

401

Invalid or missing API key.

cURL Example

Shell

curl https://platform.bindrabbit.com/api/v1/intake_documents \
    -H "Authorization: <your_agency_api_key>"

GET /api/v1/intake_documents/:id Get Intake Document ›

Returns a single intake document by ID. Documents belonging to other agencies always return 404.

Headers

Header	Required	Description
Authorization	Required	Your Agency API key (no prefix)

Query Parameters

Parameter	Type	Default	Description
include_document_url	boolean	false	When `true`, adds a 1-hour presigned S3 download URL for the original document file.

Response

200

Intake document object. With include_document_url=true, also includes document_url and document_link_expires_at.

JSON

{
  "id": 42,
  "file_name": "acord_125.pdf",
  "status": "approved",
  "source_channel": "email",
  "received_from": "broker@example.com",
  "form_template": "ACORD 25",
  "fields": {
    "insured_name": {
      "label": "Insured Name",
      "value": "ACME Corp",
      "confidence": 0.97,
      "corrected": false
    }
  },
  "form_submission": {
    "id": 7,
    "status": "signed",
    "api_url": "/api/v1/form_submissions/7"
  },
  "created_at": "2026-06-01T10:00:00.000Z",
  "reviewed_at": null,
  "delivered_at": null,
  "document_url": "https://s3.amazonaws.com/...",
  "url_expires_at": "2026-06-01T11:00:00.000Z"
}

Field	Type	Description
id	integer	Unique document ID.
status	string	One of: `received`, `processing`, `needs_review`, `unmatched`, `approved`, `sent_to_customer`, `delivered`, `failed`, `rejected`.
fields	object	Extracted field values keyed by field name. Each entry has `label`, `value`, `confidence` (0–1), and `corrected`.
form_submission	object\|null	Linked form submission, if one exists. Includes `id`, `status`, and `api_url` to fetch the full submission.
document_url	string	Presigned S3 URL to download the original file. Only present when `include_document_url=true`.
url_expires_at	string	ISO 8601 timestamp when `document_url` expires (1 hour from request time).

401

Invalid or missing API key.

404

Document not found or does not belong to your agency.

cURL Example

Shell

curl "https://platform.bindrabbit.com/api/v1/intake_documents/42?include_document_url=true" \
    -H "Authorization: <your_agency_api_key>"

Form Submissions

Completed forms submitted by your customers. Each submission belongs to a form template and may reference an originating intake document.

GET /api/v1/form_submissions List Form Submissions ›

Returns all form submissions for your agency, ordered newest first. Only submissions belonging to your agency's form templates are returned.

Headers

Header	Required	Description
Authorization	Required	Your Agency API key (no prefix)

Response

200

JSON array of form submission objects.

JSON

[
  {
    "id": 7,
    "token": "abc123...",
    "status": "signed",
    "form_template": "ACORD 25",
    "signer_name": "Jane Smith",
    "signer_email": "jane@example.com",
    "consent_given_at": "2026-06-01T10:05:00.000Z",
    "signed_at": "2026-06-01T10:06:00.000Z",
    "fields": {
      "insured_name": { "label": "Insured Name", "value": "ACME Corp" },
      "w9_form": {
        "label": "W-9 Form",
        "value": "w9_signed.pdf",
        "file_url": "https://s3.amazonaws.com/...",
        "url_expires_at": "2026-06-01T11:04:00.000Z"
      }
    },
    "intake_document": {
      "id": 42,
      "status": "approved",
      "api_url": "/api/v1/intake_documents/42"
    },
    "created_at": "2026-06-01T10:04:00.000Z"
  }
]

401

Invalid or missing API key.

cURL Example

Shell

curl https://platform.bindrabbit.com/api/v1/form_submissions \
    -H "Authorization: <your_agency_api_key>"

GET /api/v1/form_submissions/:id Get Form Submission ›

Returns a single form submission by ID. Submissions belonging to other agencies always return 404.

Headers

Header	Required	Description
Authorization	Required	Your Agency API key (no prefix)

Response

200

Form submission object.

JSON

{
  "id": 7,
  "token": "abc123...",
  "status": "signed",
  "form_template": "ACORD 25",
  "signer_name": "Jane Smith",
  "signer_email": "jane@example.com",
  "consent_given_at": "2026-06-01T10:05:00.000Z",
  "signed_at": "2026-06-01T10:06:00.000Z",
  "fields": {
    "insured_name": { "label": "Insured Name", "value": "ACME Corp" },
    "w9_form": {
      "label": "W-9 Form",
      "value": "w9_signed.pdf",
      "file_url": "https://s3.amazonaws.com/...",
      "url_expires_at": "2026-06-01T11:04:00.000Z"
    }
  },
  "intake_document": {
    "id": 42,
    "status": "approved",
    "api_url": "/api/v1/intake_documents/42"
  },
  "created_at": "2026-06-01T10:04:00.000Z"
}

Field	Type	Description
status	string	One of: `draft`, `submitted`, `signed`.
fields	object	Customer-submitted field values keyed by field name. Each entry has `label` and `value`. File upload fields also include `file_url` (1-hour presigned S3 URL) and `url_expires_at`.
intake_document	object\|null	Originating intake document, if the submission was created from one. Includes `id`, `status`, and `api_url`.

401

Invalid or missing API key.

404

Submission not found or does not belong to your agency.

cURL Example

Shell

curl https://platform.bindrabbit.com/api/v1/form_submissions/7 \
    -H "Authorization: <your_agency_api_key>"

Error Handling

The API uses standard HTTP status codes. All error responses include a JSON body.

Status	Meaning	Common Cause
200	OK	Request succeeded.
401	Unauthorized	Missing or invalid `Authorization` header.
404	Not Found	Document not found or belongs to another agency.
500	Server Error	Unexpected error. Contact support.

Error Response Shape

JSON

{
  "error": "Invalid API key"
}