Quick Start Guide
Make your first API call in 5 minutes.
Quick Start Guide
You'll go from zero to your first successful API call in under 10 minutes. By the end, you'll have an API key, a working curl command, and a clear path to building your integration.
Prerequisites
Before you start, make sure you have:
- A Leypal account with API access enabled (sign up here if needed)
curlinstalled — or any HTTP client you prefer (Postman, Insomnia, HTTPie)- 5 minutes
Step 1: Generate Your API Key
Estimated time: 2 minutes
Your API key is the token that authenticates every request to the Leypal API. Keep it secure — store it like you would a password.
- Log in to the Leypal dashboard
- Navigate to Advanced → API & Webhooks
- Click Generate API Key
- Copy the key and store it securely
Security note: Your API key is shown only once. Store it in an environment variable or secrets manager. Never commit it to version control.
# Store your key in an environment variable (recommended)
export LEYPAL_API_KEY="sk_your_key_here"Step 2: Make Your First Request
Estimated time: 1 minute
We'll make a call to fetch your existing signature requests. It's a safe, read-only call that's perfect for verifying your API key works correctly.
curl -X GET https://api.leypal.com/api/v1/signatures \
-H "X-Api-Key: YOUR_API_KEY"If you stored your key as an environment variable:
curl -X GET https://api.leypal.com/api/v1/signatures \
-H "X-Api-Key: $LEYPAL_API_KEY"Replace YOUR_API_KEY with the key you generated in Step 1, or use $LEYPAL_API_KEY if you exported it as shown above.
Step 3: Understanding the Response
Estimated time: 1 minute
A successful response returns HTTP 200 OK with a JSON body:
{
"data": [
{
"id": 1,
"subject": "Signature Request",
"status": "completed",
"type": "advanced"
}
],
"total": 1,
"skip": 0,
"limit": 10
}Field descriptions:
| Field | Description |
|---|---|
data | Array of signature requests |
data[].id | Unique request identifier — use this in subsequent calls |
data[].subject | Subject line of the signature request |
data[].status | Current status: draft, created, scheduled, expired, partially_signed, completed, rejected |
data[].type | Request type: advanced, fast, self_signed, in_person |
total | Total number of available records |
skip | Number of records skipped (for pagination) |
limit | Maximum number of records returned |
If your account has no signature requests yet, data will be an empty array [] — this is completely normal.
For more details, see the complete API reference
Step 4: Handle Common Errors
Estimated time: 1 minute
| HTTP Status | Error | Cause | Solution |
|---|---|---|---|
401 Unauthorized | Invalid credentials | Missing or incorrect API key | Verify the key in Advanced → API & Webhooks; regenerate if needed |
429 Too Many Requests | Rate limit exceeded | More than 1,000 requests per minute | Wait 60 seconds and retry; implement exponential backoff for production |
Next Steps
Congratulations! You've made your first API call. Here are the recommended next steps:
- Create a Signature Request — Send your first document for signing
- Configure Webhooks — Get notified in real time when signers complete their actions
- API Overview — Learn about authentication, rate limits, response codes, and access the complete endpoint reference