Authentication

Springstreet's API handles authentication via an API key. Requests will require an authenticated API key in order to receive data responses.

Authentication is handled via an API key. You must include your provided API key in the x-api-key header for all requests. Requests without a valid API key will be rejected with a 403 Forbidden error. For more information, see Errors

Requesting your API Key

In order to receive your API key, please contact [e-mail]

Header Example

x-api-key: YOUR_API_KEY_VALUE

Example Request

Here is an example using cURL to demonstrate how to include the header. All client libraries and tools (like Postman) will have a method for setting custom request headers.

Bash

curl --location 'https://api.springstreet.io/debtors/search?name=ABC%20Corporation' \
--header 'x-api-key: YOUR_API_KEY'