Skip to main content
GET
https://api.deepidv.com
/
v1
/
financial
/
{id}
Retrieve Bank Statement
curl --request GET \
  --url https://api.deepidv.com/v1/financial/{id}
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "organizationId": "da760e2f-2f7b-4f5d-b394-766ce9c4fad8",
  "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "senderUserId": "d4e5f6a7-b8c9-0123-defa-234567890123",
  "externalId": "loan-app-12345",
  "status": "COMPLETED",
  "type": "request",
  "Config": {
    "period": "6"
  },
  "createdAt": "2026-02-15T14:30:00.000Z",
  "updatedAt": "2026-02-15T15:00:00.000Z",
  "statement": {
    "HttpStatusCode": 200,
    "InstitutionName": "Royal Bank of Canada",
    "InstitutionId": 3,
    "Institution": "RBC",
    "Accounts": [
      {
        "Id": "acct_123456",
        "Title": "Chequing Account",
        "AccountNumber": "1234567890",
        "LastFourDigits": "7890",
        "Category": "Operations",
        "Type": "Chequing",
        "AccountType": "PersonalChequing",
        "Currency": "CAD",
        "Balance": {
          "Available": 5230.45,
          "Current": 5230.45,
          "Limit": null
        },
        "Holder": {
          "Name": "JOHN DOE",
          "Address": {
            "CivicAddress": "123 Main St",
            "City": "Toronto",
            "Province": "ON",
            "PostalCode": "M5V 2T6",
            "POBox": null,
            "Country": "CA"
          },
          "Email": "john.doe@example.com",
          "PhoneNumber": "+15192223333"
        },
        "Transactions": [
          {
            "Id": "txn_001",
            "Date": "2026-02-14",
            "Description": "PAYROLL DEPOSIT",
            "Debit": null,
            "Credit": 3200.00,
            "Balance": 5230.45,
            "Code": null
          },
          {
            "Id": "txn_002",
            "Date": "2026-02-13",
            "Description": "GROCERY STORE",
            "Debit": 87.32,
            "Credit": null,
            "Balance": 2030.45,
            "Code": null
          }
        ],
        "Statements": [],
        "OverdraftLimit": 500
      }
    ]
  }
}

GET /v1/financial/{id}
Retrieves a bank statement request by its ID. If the request is completed, the response includes the full bank statement data with account details and transaction history.

​
Request

​
Headers

HeaderRequiredDescription
x-api-keyYesYour API key

​
Path parameters

ParameterTypeRequiredDescription
idstringYesThe bank statement request ID

​
Example request

curl -X GET "https://api.deepidv.com/v1/financial/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "x-api-key: YOUR_API_KEY"

​
Response

​
200 — Success

​
Bank statement record

FieldTypeDescription
idstringUnique bank statement identifier
organizationIdstringOrganization that owns this request
userIdstringUser ID of the applicant
senderUserIdstringUser ID of the person who created the request
externalIdstringYour external reference ID (if provided)
statusstringPENDING, IN_PROGRESS, FLINKS_IN_PROGRESS, or COMPLETED
typestringrequest or upload
ConfigobjectRequest configuration (e.g. { "period": "6" })
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last-updated timestamp
statementobjectBank statement data (only present when status is COMPLETED and type is request)

​
statement object

Included only when the applicant has completed the bank connection. Sensitive fields (TransitNumber, InstitutionNumber) are stripped from account data.
FieldTypeDescription
HttpStatusCodenumberStatus code from the bank data provider
InstitutionNamestringName of the financial institution
InstitutionIdnumberIdentifier for the financial institution
InstitutionstringInstitution code
AccountsarrayArray of account objects with transaction history

​
Account object

FieldTypeDescription
IdstringAccount identifier
TitlestringAccount title/name
AccountNumberstringFull account number
LastFourDigitsstring | nullLast four digits of account number
CategorystringAccount category (e.g. Operations)
TypestringAccount type (e.g. Chequing, CreditCard)
AccountTypestringDetailed account type
CurrencystringAccount currency (e.g. CAD)
BalanceobjectAccount balances: Available, Current, Limit
HolderobjectAccount holder info: Name, Address, Email, PhoneNumber
TransactionsarrayArray of transaction objects

​
Transaction object

FieldTypeDescription
IdstringTransaction identifier
DatestringTransaction date
DescriptionstringTransaction description
Debitnumber | nullDebit amount (if applicable)
Creditnumber | nullCredit amount (if applicable)
BalancenumberRunning balance after transaction
Codestring | nullTransaction code

​
Error responses

StatusDescription
400 Bad RequestInvalid bank statement ID format
401 UnauthorizedMissing or invalid API key
403 ForbiddenBank statement belongs to a different organization
404 Not FoundBank statement ID does not exist
429 Too Many RequestsRate limit exceeded
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "organizationId": "da760e2f-2f7b-4f5d-b394-766ce9c4fad8",
  "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "senderUserId": "d4e5f6a7-b8c9-0123-defa-234567890123",
  "externalId": "loan-app-12345",
  "status": "COMPLETED",
  "type": "request",
  "Config": {
    "period": "6"
  },
  "createdAt": "2026-02-15T14:30:00.000Z",
  "updatedAt": "2026-02-15T15:00:00.000Z",
  "statement": {
    "HttpStatusCode": 200,
    "InstitutionName": "Royal Bank of Canada",
    "InstitutionId": 3,
    "Institution": "RBC",
    "Accounts": [
      {
        "Id": "acct_123456",
        "Title": "Chequing Account",
        "AccountNumber": "1234567890",
        "LastFourDigits": "7890",
        "Category": "Operations",
        "Type": "Chequing",
        "AccountType": "PersonalChequing",
        "Currency": "CAD",
        "Balance": {
          "Available": 5230.45,
          "Current": 5230.45,
          "Limit": null
        },
        "Holder": {
          "Name": "JOHN DOE",
          "Address": {
            "CivicAddress": "123 Main St",
            "City": "Toronto",
            "Province": "ON",
            "PostalCode": "M5V 2T6",
            "POBox": null,
            "Country": "CA"
          },
          "Email": "john.doe@example.com",
          "PhoneNumber": "+15192223333"
        },
        "Transactions": [
          {
            "Id": "txn_001",
            "Date": "2026-02-14",
            "Description": "PAYROLL DEPOSIT",
            "Debit": null,
            "Credit": 3200.00,
            "Balance": 5230.45,
            "Code": null
          },
          {
            "Id": "txn_002",
            "Date": "2026-02-13",
            "Description": "GROCERY STORE",
            "Debit": 87.32,
            "Credit": null,
            "Balance": 2030.45,
            "Code": null
          }
        ],
        "Statements": [],
        "OverdraftLimit": 500
      }
    ]
  }
}