Authentication and test mode

Every request needs an API key in the Authorization header. Keys come in two kinds: live keys send real documents, and test keys use a free sandbox.

Create a key

Sign in at app.readyink.ai and open Settings › Developers. Give the key a name you'll recognize later, like "Production server", and choose Live or Test. The name comes back as key_name from GET /account.

Send the key with each request

Use the Bearer scheme:

GET /v1/account HTTP/1.1
Host: api.readyink.ai
Authorization: Bearer ri_live_…

A missing key returns 401 missing_key. A wrong or revoked key returns 401 invalid_key.

Live and test keys

Live and test data are kept apart. A test key can't see live documents, and asking for one returns 404.

Test mode

Use a test key while you build. You can run the whole flow, from creating a draft to downloading the signed PDF, without spending tokens or emailing real people.

• Signing a test document: open the email in your test inbox and sign it as the recipient. If the recipient gets texts, enter 000000 as the code.
• Your code doesn't change: endpoints, requests and responses are the same in both modes. Only the key changes.
• Going live: swap in an ri_live_ key. Make sure your account has tokens first; GET /account shows your balance.

Keep keys safe

• Keep keys on your server. Never put them in a browser, a mobile app or a public repository.
• Store them in environment variables or a secrets manager.
• Use a separate key for each app or environment so you can revoke one without affecting the others.
• If a key leaks, revoke it under Settings › Developers and create a new one. Requests with the old key return 401 invalid_key straight away.