Common API Objects and Fields
This section covers the fundamental API building blocks and fields that you’ll encounter throughout our API. Understanding these components is crucial for effective API integration.
Understanding Object IDs
Our API uses unversioned GUIDs to uniquely identify objects within our service. These IDs are:
- Automatically assigned upon object creation
- Included in all message responses
- Used for subsequent API operations (update/modify/delete)
The following objects are uniquely identified using these IDs:
- Customers
- Entities
- Documents
- Addresses
- Document scans
- Checks
- Batches
- Transaction groups
The Document Object
Scanned Documents in Business Check Results
Document Data Options
Performance Note
Control document inclusion in results using the documentData parameter:
The Entity Object
An entity represents either a person or business in our system. It contains structured data including personal/organizational information and can hold multiple Document Objects.
Key Value Pairs (KVPs)
Key Value Pairs provide flexibility for storing additional data that doesn’t fit into our standard object structure. While stored as strings, KVPs include type hints for better data handling.
RequestID (Transaction ID)
Every API response includes a unique RequestID based on the ULID (Universally Unique Lexicographically Sortable Identifier) specification.
- Time-based UUID (ULID format)
- Contains millisecond-precision timestamp
- Includes random element
- Sortable alphabetically and chronologically
- Trace results within FrankieOne
- Retrieve past API call results
- Track transactions in your system
- Essential for troubleshooting
Always save the RequestID in your logs. It’s the most valuable piece of information when troubleshooting with FrankieOne support.
While RequestIDs are chronologically sortable, don’t rely on them for strict time-based operations. Use dedicated timestamp fields for such purposes.