API Reference
update Changelog
GET

Get connection

language https://api.araucaria.money/v1/connections/{connectionId}

Returns the current status and details of a connection.


Parameters

Name Type Description
connectionId * path string

Request Example

bash
curl -X GET "https://api.araucaria.money/v1/connections/{connectionId}" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Example

200 OK
json
{
  "connectionId": "conn_01HQ3K5J7X8Y9Z0A1B2C3D4E5F",
  "institutionId": "cl_banco_estado",
  "status": "CONNECTED",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:35:00Z"
}

Response Fields

Field Type Description
connectionId * string Unique connection identifier
institutionId object Bank institution identifier
status * "CREATED" | "CREDENTIALS_SUBMITTED" | "VERIFYING" | "CONNECTED" | "FAILED_AUTH" | "ERROR" Current connection status
createdAt * string When the connection was created
updatedAt * string When the connection was last updated