Getting Started
A guide for integrating with our B2B API.
Authentication
Connect uses static API keys to authenticate the API. Sandbox and Production API keys will be provisioned and securely shared with a designated person from your team upon request.
Include your API key on the standard authorization header when sending requests:
curl -H "Authorization: <YOUR API KEY>" https://api.connect.financial
All requests must be made over https.
Access to our API is IP whitelisted by default. Please reach out to us to coordinate access to our sandbox or production environments.
Pagination
All endpoints that list objects provide support for pagination.
We utilize offset and limit based pagination via the limit and startAfterId fields. Objects will be returned in inverse chronological order, such that the most recently created object will be returned first on the list and the oldest will be returned last.
The startAfterId parameter returns objects listed after the provided object. The limit parameter dictates the maximum size of the result array. The default limit is 10 and the maximum limit is 100. Lastly, a response will include a has_more field set to true or false depending on whether there are more pages to iterate through or if a page is the last one.
Trace IDs
Most response payloads from the Connect API will contain trace IDs, which are unique identifiers assigned to every API request.
Trace IDs will be included in the body of the response. For example:
{
"message": "Portfolio created with success.",
"data": { "id": "42dc3aed-b56f-41b8-a12a-fd2b189f556e" },
"traceId": "0f802100-bdfd-46a8-9d81-ca1b623f5fab",
}
Trace IDs are helpful when troubleshooting requests against our API. We recommend including trace IDs for the relevant API requests when opening cases with our support team.
Errors
The Connect API attempts to handle all errors and mistakes as gracefully and with as much detail as possible.
HTTP Error Codes
We use HTTP codes to group errors.
| Status Code | Description |
|---|---|
200 | OK. Your request worked as expected successfully. |
400 | Bad Request. Your request failed due to the information in the request or situational reasons (e.g. an insufficient balance or a validation error on the request). |
401 | Unauthorized. No valid API key or session token provided. |
403 | Forbidden. You don't have permission to perform the request. |
404 | Not Found. The requested resource does not exist. |
408 | Request timeout. |
429 | Too Many Requests. Too many requests hit the API too quickly. |
5xx | Something went wrong in our systems (extremely rare). You should assume that we are being paged for all 5xx errors. |
Error Attributes
There are five fields that are returned in error response bodies.
| Attribute | Description |
|---|---|
type | The overarching category of the error. |
code | The specific error. It is a short string that you can handle programmatically if you choose. |
message | A human readable error message meant to be read by a developer, not an end consumer. message will change and should not be used programmatically. If you want consumer-friendly error messaging, we recommend you map off of code. |
details | An object with key-value pairs that may provide more details about the error. For example, a parameter validation error will have the list of parameters that are invalid with reasons. In some cases, details may be omitted. |
Need Help?
Contact us @ techsupport@connect.financial