1. Use Cases

This guide provides practical examples and step-by-step instructions for common integration scenarios using the Remitian Public API. Each use case includes sample requests, expected responses, and implementation guidance.


​
Authentication Headers

For every request in these use cases, ensure you include the required authentication headers:

  • Authorization: Bearer YOUR_ACCESS_TOKEN
  • x-api-key: YOUR_API_KEY

See the Authentication Guide for details on obtaining access tokens.


​
Sandbox Environment Warning

IMPORTANT: When testing with the sandbox environment, DO NOT use real customer data.

  • Use only synthetic/test data for all API calls
  • Do not include actual taxpayer information, Social Security Numbers, or EINs
  • Do not use real bank account numbers or payment information
  • Create fictitious names, addresses, and financial data for testing purposes

Real customer data should only be used in the production environment with proper security measures and user consent.


​
Available Use Cases

​
Use Case 1: Manage Firms

Synchronize firm data between your system and Remitian. Create and list firms using your system’s firm ID with the externalId field.

​
Use Case 2: Manage Firm Users

Manage firm users within Remitian. Create, list, and remove firm users associated with firms using your system’s user ID with the externalId field.

​
Use Case 3: Manage Taxpayers

Synchronize taxpayer data between your system and Remitian. Create, list, deactivate, and change the owner of taxpayers associated with firms, or provision a taxpayer together with its tax entities and tax accounts in a single call.

​
Use Case 4: Manage Tax Entities

Manage tax entities associated with taxpayers. Create and list tax entities for individuals and businesses.

​
Use Case 5: Manage Tax Accounts

Manage tax accounts associated with tax entities. Create and list tax accounts for different tax authorities.

​
Use Case 6: Manage Tax Identity Verifications

Manage tax identity verifications associated with tax entities. Create and list verifications for different tax authorities and discover the fields each one requires.

​
Use Case 7: Manage Bank Accounts

Manage bank accounts associated with taxpayers or firms. Create, list, and delete ACH and EFT bank accounts using your system’s bank account ID with the externalId field, and register a firm’s own ACH bank account.

​
Use Case 8: Schedule Tax Payments

Schedule tax payments associated with tax accounts. Create tax payments using your system’s tax payment ID, mark a tax payment as paid manually, or submit up to 5,000 tax payments for a firm in a single batch and read the result of each one.

​
Use Case 9: Import Tax Forms

Import tax forms associated with taxpayers. Upload tax form data and let Remitian extract the relevant information.

​
Use Case 10: Passwordless Authentication Integration

Enable your users to access Remitian’s platform seamlessly from your application using passwordless authentication.