Skip to main content
GET
https://api.deepidv.com
/
v1
/
financial
/
externalId
/
{externalId}
List Bank Statements by External ID
curl --request GET \
  --url https://api.deepidv.com/v1/financial/externalId/{externalId}
{
  "bankStatements": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "organizationId": "da760e2f-2f7b-4f5d-b394-766ce9c4fad8",
      "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "senderUserId": "d4e5f6a7-b8c9-0123-defa-234567890123",
      "status": "COMPLETED",
      "type": "request",
      "Config": {
        "period": "6"
      },
      "createdAt": "2026-02-15T14:30:00.000Z",
      "updatedAt": "2026-02-15T15:00:00.000Z"
    }
  ],
  "nextToken": null
}

GET /v1/financial/externalId/{externalId}
Returns a paginated list of bank statement requests matching the given external ID, sorted by creation date (newest first).

​
Request

​
Headers

HeaderRequiredDescription
x-api-keyYesYour API key

​
Path parameters

ParameterTypeRequiredDescription
externalIdstringYesYour external reference ID

​
Query parameters

ParameterTypeRequiredDescription
nextTokenstringNoPagination token from a previous response

​
Example request

curl -X GET "https://api.deepidv.com/v1/financial/externalId/loan-app-12345" \
  -H "x-api-key: YOUR_API_KEY"

​
Response

​
200 — Success

FieldTypeDescription
bankStatementsarrayArray of bank statement summary objects
nextTokenstring | nullPagination token to fetch the next page. null when no more results

​
Bank statement summary object

FieldTypeDescription
idstringUnique bank statement identifier
organizationIdstringOrganization that owns this request
userIdstringUser ID of the applicant
senderUserIdstringUser ID of the person who created the request
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

​
Error responses

StatusDescription
400 Bad RequestInvalid external ID or query parameters
401 UnauthorizedMissing or invalid API key
403 ForbiddenBank statements belong to a different organization
404 Not FoundNo bank statements found with the given external ID
429 Too Many RequestsRate limit exceeded
{
  "bankStatements": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "organizationId": "da760e2f-2f7b-4f5d-b394-766ce9c4fad8",
      "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "senderUserId": "d4e5f6a7-b8c9-0123-defa-234567890123",
      "status": "COMPLETED",
      "type": "request",
      "Config": {
        "period": "6"
      },
      "createdAt": "2026-02-15T14:30:00.000Z",
      "updatedAt": "2026-02-15T15:00:00.000Z"
    }
  ],
  "nextToken": null
}