Coator
Sign inGet started
HomeAPI docs

API Reference

v1 · Preview

A REST API for uploading portfolios, managing transformation mappings, and retrieving processed files. Full documentation coming soon.

Authentication

All requests must include an API key in the Authorization header. You can generate API keys from your account settings.

Authorization: Bearer coator_live_xxxxxxxxxxxxxxxxxxxx

Base URL

https://api.coator.io

Endpoints

POST/v1/portfolios— Upload a portfolio

Upload a debt portfolio file. The file will be transformed using the mapping rules associated with the specified client.

Request

POST /v1/portfolios
Authorization: Bearer {api_key}
Content-Type: multipart/form-data

{
  "client_id": "CRED-001",
  "mapping_id": "map_abc123",
  "file": <binary>
}

Response

{
  "portfolio_id": "PF-2024-00142",
  "status": "processing",
  "created_at": "2024-11-01T08:30:00Z",
  "claim_count": null
}
GET/v1/portfolios/{id}— Get a portfolio

Retrieve the status and metadata of a previously uploaded portfolio.

Request

GET /v1/portfolios/PF-2024-00142
Authorization: Bearer {api_key}

Response

{
  "portfolio_id": "PF-2024-00142",
  "status": "ready",
  "created_at": "2024-11-01T08:30:00Z",
  "claim_count": 142,
  "client_id": "CRED-001",
  "mapping_id": "map_abc123"
}
GET/v1/portfolios/{id}/download— Download transformed file

Download the portfolio in the Coator standard XML format, or in a custom output format by specifying a target mapping.

Request

GET /v1/portfolios/PF-2024-00142/download
Authorization: Bearer {api_key}
Accept: application/xml

# Optional: download in a custom output format
?output_mapping_id=map_agency_xyz

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Disposition: attachment; filename="PF-2024-00142.xml"

<?xml version="1.0" encoding="UTF-8"?>
<DebtPortfolio xmlns="https://schema.coator.io/v1" version="1.0">
  ...
</DebtPortfolio>
GET/v1/mappings— List mappings

List all transformation mapping rules available to your account.

Request

GET /v1/mappings
Authorization: Bearer {api_key}

Response

{
  "data": [
    {
      "mapping_id": "map_abc123",
      "name": "Acme Finance import",
      "direction": "inbound",
      "created_at": "2024-10-15T12:00:00Z"
    },
    {
      "mapping_id": "map_agency_xyz",
      "name": "Agency XYZ export",
      "direction": "outbound",
      "created_at": "2024-10-20T09:00:00Z"
    }
  ]
}

This is a preview. The API is under active development. Endpoints, request shapes, and response formats may change before the stable v1 release. Have questions? Contact us.