For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Legacy DocsSign in
DocumentationChangelog
DocumentationChangelog
  • Get Started
    • Introduction
    • Get your API keys
    • Support
    • Privacy policy
    • Status
  • Transaction Enrichment
    • Overview
    • Entities Identification
    • Categorization
    • Recurrence
  • Bank Statements
    • Overview
    • Fast verification
  • Core resources
    • Batches
    • Entities
    • Account Holders
    • Webhooks
    • Personalization
    • Reporting wrong results
  • API Reference
    • Authentication
    • Errors
    • Request IDs
    • Pagination
    • Rate limits
LogoLogo
Legacy DocsSign in
On this page
  • Optional account holder fields
  • Accessing account holder history
Core resources

Account Holders

Was this page helpful?
Previous

Webhooks

Next
Built with

When using the Ntropy API, you can provide information about the account holder of a certain transaction. In this way, when you enrich a transaction using the API or SDK, it will also be added to that account holder’s transaction history.

An account holder represents an entity (business, consumer) that can be uniquely identified by an id and holds the account associated with the transaction.

Account holders provide important context for understanding transactions and allow additional operations such as:

  • Identifying recurrence between transactions of the same account.
  • Insights for an account holder such as income information over a period of time, subscriptions, and so on.

Optional account holder fields

Account holders allow for optional fields that can improve the quality of the enrichment significantly:

  • name: The name of the account holder
  • industry: The industry in which the account holder operates
  • website: The website of the account holder

Accessing account holder history

At any point, after adding transactions to an account holder’s history. You can retrieve it by supplying its id to the Transactions API:

1from ntropy_sdk import SDK
2
3sdk = SDK("cd1H...Wmhl")
4for tx in sdk.transactions.list(
5 account_holder_id="35b927b6-6fda-40aa-93b8-95b47c2b2cad"
6).auto_paginate():
7 ...
See the full raw output
Response
1{
2 "next_cursor": "XjdHaksD",
3 "data": [
4 {
5 "id": "xbx8YP14g565Xk",
6 "description": "SQ* STARBUCKS 10 Union Sq",
7 "date": "2024-03-30",
8 "amount": 10,
9 "entry_type": "outgoing",
10 "currency": "USD",
11 "created_at": "2024-03-30T00:00:00",
12 "entities": {
13 "counterparty": {
14 "type": "organization",
15 "id": "d4bc3c80-ec1a-3da2-836e-2a4ca4758be5",
16 "name": "Starbucks",
17 "website": "starbucks.com",
18 "phone_number": "+1 4153753176",
19 "tax_number": "80-0429876",
20 "naics2017": "541519",
21 "logo": "https://logos.ntropy.com/starbucks.com",
22 "mccs": [
23 5814
24 ]
25 },
26 "intermediaries": [
27 {
28 "id": "916bc837-55ef-3106-88f6-5a8269ca9f2a",
29 "name": "Square, Inc.",
30 "website": "squareup.com",
31 "logo": "https://logos.ntropy.com/squareup.com",
32 "mccs": []
33 }
34 ]
35 },
36 "categories": {
37 "general": "coffee shop"
38 },
39 "location": {
40 "raw_address": "10 Union Square E, New York, New York 10003, United States",
41 "structured": {
42 "street": "Union Square East",
43 "city": "New York",
44 "state": "New York",
45 "postcode": "10003",
46 "country_code": "US",
47 "country": "United States",
48 "house_number": "10",
49 "latitude": 40.734834,
50 "longitude": -73.989782,
51 "google_maps_url": "https://www.google.com/maps/search/?api=1&query=40.734834,-73.989782",
52 "apple_maps_url": "https://maps.apple.com/?q=40.734834,-73.989782"
53 }
54 },
55 "account_holder_id": "35b927b6-6fda-40aa-93b8-95b47c2b2cad"
56 }
57 ]
58}