Citi API

Finance / API Key Intermediate HTTPS

72 B

Metadata Score Metadata estimate · not endpoint-tested

Visit Official Site Compare Alternatives

Overview

Citi's partner API provides access to Citigroup banking account and statement data, enabling developers to build financial apps that read account balances, transactions, and statements on behalf of authorized users. The API uses OAuth for secure user authentication, making it suitable for personal finance and fintech applications. This is a sophisticated API intended for developers building bank-integrated financial tools.

Beginner Tip

Citi's API requires a formal partner agreement and approval process before you can get production access, so plan ahead if you need it for a real product. Start with the sandbox environment to test your integration while your application is being reviewed.

Available Data

The kind of data this API exposes, based on its documentation. We could not call the endpoint to confirm the exact field names.

Citi data via REST API

Example Response

Illustrative shape only — we were not able to call this endpoint (it requires credentials or exposes no public sample URL), so the fields below show the kind of data this API returns rather than a recorded response.

JSON Response · Illustrative

{
  "status": "success",
  "data": {
    "result": "Data from Citi",
    "description": "All Citigroup account and statement data APIs",
    "timestamp": "2025-01-15T10:00:00Z"
  }
}

Field Reference

accountId Unique identifier for the bank account, used in subsequent API calls.

accountNickName The user-defined nickname for the account.

currentBalance The current balance of the account in the account's currency.

availableBalance The amount currently available to spend, excluding pending transactions.

currencyCode ISO 4217 currency code for the account (e.g., "USD", "SGD").

Implementation Example

Calls a real endpoint of this API. Replace any placeholder credentials with your own key.

Request

const url = "https://sandbox.developerhub.citi.com/api-catalog-list";
// Replace headers or query params with the values required by this API.
const response = await fetch(url, {
  headers: {
  "X-API-Key": "YOUR_API_KEY"
  }
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data);

What Can You Build?

Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.

Common Errors & Troubleshooting

Generated guidance based on this API's documentation, not observed by us. Treat it as a starting point and check against the provider's own error reference.

401 Unauthorized The OAuth access token is expired or the client credentials are invalid.

✓ Refresh the access token using the OAuth 2.0 refresh token flow and ensure your client_id is included in every request header.

403 Forbidden Your app does not have permission for the requested API endpoint.

✓ Check that the required scopes were approved during the partner onboarding process; some endpoints require additional permissions.

404 Not Found The account ID in the URL does not exist or does not belong to the authenticated user.

✓ First call the /accounts endpoint to retrieve valid account IDs, then use those IDs in subsequent requests.

Metadata Score Breakdown

Estimated from metadata — endpoint not independently tested

This score is estimated from observable metadata — HTTPS support, authentication model, declared CORS, and documentation reachability — because the API requires authentication or exposes no publicly testable endpoint. The five-signal breakdown is only shown for live-tested APIs.

Metadata estimate · endpoint not independently tested

How is this scored? →