- API Reference
API Reference
Endpoint-level reference for the Remitian Public API: parameters, request and response schemas, and an interactive request runner.
The guides explain the integration model. These pages describe each endpoint: path parameters, query parameters, request body, responses and error codes, with a Try it panel that sends the request to Sandbox.
Base URLs
| Environment | Base URL |
|---|---|
| Sandbox | https://public-api.sandbox.remitian.com |
| Production | https://public-api.remitian.com |
Authentication
Every endpoint except the token endpoint and the health check requires two headers: Authorization: Bearer YOUR_ACCESS_TOKEN and x-api-key: YOUR_API_KEY. See Authentication for how to obtain them, and Security for rate limits and IP allowlisting.
Start in Sandbox with synthetic data only. The Sandbox rate limit is 200 requests per 10 minutes. See Environments.
Try It
Every endpoint page has a Try it panel. It sends a real request to Sandbox (https://public-api.sandbox.remitian.com) and shows the response on the page.
- Get an access token. Open Create an access token, fill in the request body with your Sandbox credentials and send the request. Copy
accessTokenfrom the response. This endpoint and the health check need no token. - Fill in the headers. Open the endpoint you want to call. Paste the access token in the Bearer token field and your Sandbox API key in the
x-api-keyheader. - Send the request. Fill in the path parameters, the query parameters and the body, then send. The panel shows the status code and the response body.
Try it always calls Sandbox, so use Sandbox credentials and synthetic data only. The requests are real: they create and change data in your Sandbox account and count toward the rate limit. An access token expires after 10 minutes by default; create a new one when a request returns 401 Unauthorized.
Errors
Error responses use the Error schema: title, status, detail and, on 400 Bad Request, an errors object keyed by field name with the validation messages.
Endpoints
Authentication
Obtain access tokens and create passwordless authentications.
Health
Verify connectivity and credentials.
Firms
Create, list, read and update firms, and upload their logo.
Firm Users
Create, list and remove the users of a firm.
Taxpayers
Create, list, read, deactivate and provision taxpayers, and change their owner.
Tax Entities
Create, list and read the individuals and businesses of a taxpayer.
Tax Accounts
Create and list the tax accounts of a taxpayer.
Tax Identity Verifications
Discover connection types and create, read and list verifications with tax authorities.
Bank Accounts
Manage the bank accounts of taxpayers and firms.
Payment Types
List the payment types accepted when scheduling tax payments.
Tax Payments
Schedule and list tax payments, and list funding paces.
Tax Payment Batches
Submit batches of tax payments and read their results.
Tax Forms
Import tax forms and read the parsing requests.