​
Credira API Documentation

Welcome to the Credira API - the comprehensive solution for automating your debt recovery and customer communication processes. Our API enables you to programmatically manage calls, emails, and customer interactions with intelligent voice agents.
Credira API provides powerful automation tools for debt recovery, customer communication, and payment processing through intelligent voice agents and email systems.

​
What is Credira?

Credira is an AI-powered debt recovery platform that automates customer communication through intelligent voice agents and email systems. Our API allows you to:
  • Automate debt collection calls with AI voice agents
  • Send personalized emails with dynamic templates
  • Track customer interactions and payment responses
  • Manage callouts and campaigns programmatically
  • Monitor success rates and optimize recovery strategies

​
Quick Start

1

Get Your API Key

Sign up for a Credira account and obtain your API key from the dashboard. Your API key is required for all API requests.
2

Choose Your Integration

Select the integration method that works best for your system:
  • Direct API Integration - Use our REST API endpoints
  • Webhook Integration - Receive real-time updates
  • SDK Integration - Use our official SDKs
3

Make Your First Call

Use the Create Call endpoint to initiate your first automated debt recovery call:
curl --request POST \
     --url https://api.credira.com/v1/calls \
     --header 'Authorization: Bearer YOUR_API_KEY' \
     --header 'Content-Type: application/json' \
     --data '{
       "phone_number": "+1234567890",
       "invoice_id": "inv_123456",
       "voice_agent_id": "agent_456789"
     }'
4

Monitor Results

Track call outcomes, customer responses, and payment status through our comprehensive reporting dashboard.

​
Authentication

All API requests require authentication using your API key. Include your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
Keep your API key secure and never expose it in client-side code. Use environment variables or secure configuration management.

​
Base URL

All API requests are made to our base URL: 
https://api.credira.com/v1

​
Rate Limits

  • Standard Plan: 1,000 requests per hour
  • Professional Plan: 10,000 requests per hour
  • Enterprise Plan: 100,000 requests per hour
Rate limit headers are included in all responses:
  • X-RateLimit-Limit: Maximum requests allowed
  • X-RateLimit-Remaining: Requests remaining in current window
  • X-RateLimit-Reset: Time when the rate limit resets

​
Response Format

All API responses follow a consistent JSON format: 
{
  "success": true,
  "data": {
    // Response data here
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}

​
Error Handling

The API uses standard HTTP status codes and returns detailed error information: 
{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Missing required parameter: phone_number"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}

​
Common Status Codes

​
200
integer
Success - Request completed successfully
​
400
integer
Bad Request - Invalid request parameters
​
401
integer
Unauthorized - Invalid or missing API key
​
404
integer
Not Found - Resource not found
​
429
integer
Too Many Requests - Rate limit exceeded
​
500
integer
Internal Server Error - Server error occurred

​
SDKs and Libraries

We provide official SDKs for popular programming languages: 
npm install @credira/api-client

import { CrediraClient } from '@credira/api-client';

const client = new CrediraClient({
  apiKey: 'your-api-key'
});

const call = await client.calls.create({
  phoneNumber: '+1234567890',
  invoiceId: 'inv_123456',
  voiceAgentId: 'agent_456789'
});

​
Webhooks

Receive real-time notifications about call outcomes, email delivery status, and customer interactions: 
{
  "event": "call.completed",
  "data": {
    "call_id": "call_123456789",
    "status": "completed",
    "duration": 180,
    "outcome": "payment_scheduled"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

​
Support

Need help? We’re here to assist you:
  • Documentation: Browse our comprehensive API reference
  • Support Email: support@credira.com
  • Status Page: Check our system status at status.credira.com
  • Community: Join our developer community for tips and best practices
Start with our Quick Start guide to get up and running in minutes, then explore the full API reference for advanced features.