Overview

Welcome to the Ahrvo Enhanced Checks API documentation. This RESTful service enables you to upload merchants' check lists for printing and mailing, manage documents, track shipments, and access positive pay data.

Getting Started

To use the Enhanced Checks API, you'll need to:

1. Authenticate - Obtain a JWT token using your account credentials
2. Get Bank List - Retrieve your registered bank accounts
3. Upload Checks - Submit check batches for processing
4. Track Status - Monitor your check processing and delivery

Available API Functions

Authentication & Setup

• Authentication - Retrieve JWT tokens for API access
• Get Bank List - List registered bank accounts

Check Management

• Upload Labeled Batch - Upload a batch of checks for processing
• Upload Labeled Batch Status - Check the status of uploaded batches
• Get Checks by Batch ID - Retrieve checks by batch identifier
• Get Checks by Bundle ID - Retrieve checks by bundle identifier
• Get Checks by Merchant Transaction ID - Retrieve checks by merchant transaction ID
• Get Checks by Check Trans ID - Retrieve checks by check transaction ID

Document Handling

• Upload Document - Upload documents to attach to checks or process independently
• Get Check PDF File - Retrieve PDF copies of printed checks

Tracking & Reporting

• Get Tracking History - View shipment events and delivery status
• Get Positive Pay Data - Access positive pay report data for fraud prevention

API Servers

Staging Server

• URL: https://gateway.ahrvo.network
• Description: Use this server for testing and development

Production Server

• URL: https://api.ahrvo.network
• Description: Use this server for production

Authentication

All API endpoints (except the Authentication endpoint itself) require authentication via two headers:

JWT Bearer Token

Authorization: Bearer <your-jwt-token>

Tokens can be configured with custom expiration times or set to never expire. Note that generating a new token invalidates all previously issued tokens for your account.

API Key

x-api-key: <your-api-key>

The x-api-key header is required for all endpoints to authenticate your requests to the Ahrvo platform. Contact Ahrvo support to obtain your API key.

Best Practices

1. Secure Token Storage - Store JWT tokens securely and refresh them according to your security policies
2. Error Handling - Always check the errorCode and errorMessage fields in API responses
3. Batch Validation - Verify individual check status within batches, as accepted batches may contain rejected checks
4. Testing - Use the staging server for development and testing before moving to production