Skip to Content
API ReferenceOverview

API Reference

The IdentityCall API is organized around REST. Our API accepts JSON request bodies, returns JSON responses, and uses standard HTTP response codes.

Base URL

All API requests should be made to:

https://api.identitycall.ai/api/v1/public

Authentication

The API uses Bearer token authentication. Include your API key in the Authorization header:

Authorization: Bearer idc_your_api_key

See Authentication for details on creating and managing API keys.

Content Types

All requests that include a body should use:

  • multipart/form-data for file uploads
  • application/json for JSON data

All responses are returned as application/json.

Endpoints

Recordings

EndpointMethodDescription
/recordingsGETList all recordings
/recordingsPOSTUpload a new recording
/recordings/:idGETGet recording details
/recordings/:idPATCHUpdate recording metadata
/recordings/:idDELETEDelete a recording
/recordings/:id/transcriptionGETGet transcription
/recordings/:id/resultsGETGet analysis results
/recordings/:id/summaryGETGet call summary

Projects

EndpointMethodDescription
/projectsGETList projects
/projectsPOSTCreate a project
/projects/:idGETShow project
/projects/:idPATCHUpdate project
/projects/:idDELETEDelete project

Virtual Numbers

EndpointMethodDescription
/virtual_numbersGETList virtual numbers
/virtual_numbers/availableGETSearch available numbers
/virtual_numbersPOSTPurchase a number
/virtual_numbers/:idGETShow a virtual number
/virtual_numbers/:idPATCHUpdate a virtual number
/virtual_numbers/:id/operatorsPOSTAttach an operator
/virtual_numbers/:id/operators/:operator_idDELETEDetach an operator

Operators

EndpointMethodDescription
/operatorsGETList operators
/operatorsPOSTCreate an operator
/operators/:idGETShow an operator
/operators/:idPATCHUpdate an operator
/operators/:idDELETEDelete an operator

Pagination

List endpoints return paginated results. Use these query parameters:

ParameterTypeDefaultDescription
pageinteger1Page number
per_pageinteger20Items per page (max 100)

Response format:

{ "data": [...], "meta": { "current_page": 1, "total_pages": 5, "total_count": 100, "per_page": 20 } }

Error Handling

The API uses standard HTTP status codes:

CodeDescription
200Success
201Created
204No Content (successful delete)
400Bad Request
401Unauthorized
403Forbidden
404Not Found
422Unprocessable Entity
429Too Many Requests
500Internal Server Error

Error responses include a message:

{ "error": "Description of what went wrong" }

See Errors for detailed error handling guidance.