Object IDs
Every object in our API is assigned a unique, unversioned GUID (Globally Unique Identifier) upon creation. These IDs are essential for performing operations on specific resources.
Understanding Object IDs
When you create a new resource through our API, the response will always include an automatically generated ID. This ID serves as the primary identifier for that resource in all subsequent API operations.
Using Object IDs
Object IDs are required when you need to:
- Retrieve specific resources
- Update existing resources
- Delete resources
- Create relationships between resources
Resources with Unique IDs
Core Resources
- Customers
- Entities
- Documents
- Addresses
Transaction Resources
- Document scans
- Checks
- Batches
- Transaction groups
Always store these IDs in your system when creating new resources. You’ll need them for future API operations.