Quickstart

1. Create a test key

In the partner portal, open Integrations and create a Test key. See API keys.

2. Submit an application

Replace the key. Use your own record id for call.id: it must be unique for each application you send.

curl -sS -X POST https://api.getcredify.com/intake \
  -H "Authorization: Bearer sk_test_YourTestKeyGoesHere0000000000" \
  -H "Content-Type: application/json" \
  -d '{
    "call": { "id": "crm-application-10481" },
    "product": "Home",
    "consent": { "sms_review_link": true },
    "customer": {
      "first_name": "Ann",
      "last_name": "Lee",
      "email": "ann.lee@example.com",
      "phone": "1234567890"
    },
    "address": {
      "line_1": "123 Main St",
      "city": "Austin",
      "state": "TX",
      "postal_code": "78701"
    }
  }'

3. Read the response

201 Created means the draft exists:

{
  "quoteId": "8f3c2a9e-…",
  "status": "pending_review",
  "clientRef": "b21e47d0-…",
  "reviewLink": {
    "sent": false,
    "reason": "test_mode",
    "sms": { "sent": false, "reason": "test_mode" },
    "email": { "sent": false, "reason": "test_mode" }
  },
  "warnings": [],
  "missingCriticalFields": []
}

Store clientRef against your own record of the customer. It is how this application appears in your reporting, and how a policy that binds is traced back to you.

A test key never messages the customer, so reviewLink reports test_mode. With a live key, the customer is texted and emailed a secure link to review and confirm the application. Nothing is rated until they confirm.

4. Retry safely

Send the identical request again. You get 200 with "idempotent": true and the same quoteId and clientRef, and no second application is created. Any time a request fails or times out, retry it with the same call.id.

5. Go live

Swap in a live key and change nothing else. Before you do, work through the go-live checklist.