Help and FAQ
Answers to the questions developers ask most. Can't find yours? A real person reads every message.
Frequently asked questions
Do I need a separate plan to use the API?
No. The API uses the same tokens as the app. One token covers one signer on one document, and copy recipients are free. See pricing.
Where do I get an API key?
Sign in at app.readyink.ai and open Settings › Developers. Create a test key (ri_test_) while you build and a live key (ri_live_) when you're ready.
Can I try the API for free?
Yes. Test keys use a sandbox where sends cost 0 tokens, emails and texts go to your test inbox, and the text code is always 000000.
Does the API send webhooks?
Not yet. Check GET /documents or GET /documents/{id} on a schedule. Tracking and results shows how.
Do signers need a readyink.ai account?
No. They get a link by email, text or both, and sign in any browser on any device.
What files can I send?
PDFs up to 25 MB, one per document. Convert Word documents and images to PDF first.
How many recipients and fields can a document have?
You can add up to 50 recipients when you create a document, and up to 200 fields in one request.
Can I send text messages instead of email?
Yes. Set notify_via to sms or both and include a US mobile number. Each recipient still needs an email address.
Can I change a document after sending it?
You can change how often reminders go out and fix a recipient's email. For anything else, cancel the document and create a new one.
Do I get tokens back if I cancel?
Only if no one had opened the document. The cancel response shows how many in tokens_returned.
What happens if my send request times out?
Send it again with the same Idempotency-Key. If the first request worked, you get the same result back and nothing is sent or charged twice.
Why do I get a 404 for a document I can see in the app?
Live and test data are separate. A test key can't see live documents, and a live key can't see test documents.
How do I place fields without working out coordinates?
Prepare the document in the readyink.ai app, where AI suggests the fields for each signer. Then use the API to track it and download the signed PDF.
Is there an OpenAPI spec?
Yes. Download it from https://api.readyink.ai/v1/openapi.json and import it into Postman, Insomnia or a code generator. The interactive reference is built from the same file.
Troubleshooting checklist
| Symptom | Check |
|---|---|
401 on every request |
The header is Authorization: Bearer <key>, with no quotes or extra spaces, and the key hasn't been revoked. |
404 for a real document |
You're using the right kind of key, live or test, for that document. |
409 file_not_ready when adding fields |
Wait until file_status is ready after uploading. |
422 not_ready_to_send |
Read problems. A common cause is a signer with no fields. |
402 insufficient_tokens |
Buy tokens at checkout_url, or use a test key while you build. |
| Downloads fail or return HTML | Follow redirects (curl -L), and request a new link if it's older than 10 minutes. |
| Signer didn't get the email | Check the address and spam folder. If it's wrong, fix it with a recipient PATCH. In test mode, look in your test inbox. |
429 rate_limited |
Wait Retry-After seconds. Sends are limited to 10 a minute per key. |
Contact support
- Email: info@readyink.ai
- Contact form: readyink.ai/contact
- Mail: readyink.ai, 601 S. Meridian Suite L1, Indianapolis, IN 46225
When you write about an error, include the error code, the document ID and roughly when it happened. Never send your API key.
Changelog
| Version | Notes |
|---|---|
| v1.0.0 | First public version: account, documents, recipients, fields, quotes, sending, cancelling, events, signed PDF and certificate downloads, and a test-mode sandbox. |