⌘K
OverviewInitializeVerifyPayoutWebhooksError CodesGo-Live
v1.0

Introduction

The CredDot API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.


Authentication

The CredDot API uses API keys to authenticate requests. You can view and manage your API keys in the CredDot Dashboard.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.


HTTP Response Codes

200 - OK

Everything worked as expected.

400 - Bad Request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

No valid API key provided.

404 - Not Found

The requested resource doesn't exist.

500 - Server Errors

Something went wrong on CredDot's end.

Service Endpoints
BASE URL

https://api.creddot.com/v1

Authentication Header
cURL

curl https://api.creddot.com/v1/transactions \
  -u YOUR API KEY: \
  -H "Authorization: Bearer YOUR API KEY"

Important
Replace YOU API KEY with your actual test or live secret key from the dashboard.