Make your first API call
Set up the Remitian Postman collection, get an access token and run a health check to confirm your setup works.
What it is
The quickest way to confirm your credentials work is the pre-configured Remitian Postman collection. It handles token storage for you and includes requests for every resource in the API.
When you need it
Right after you create your first Client Application in the Developer Portal, and any time you want to explore endpoints without writing code.
How it works
- Download the Postman collection and environment (a zip file) from the Postman Setup page and install Postman if you have not already.
- Import both files into Postman using the Import button.
- Set the six environment variables in the imported Remitian environment (see the table below).
- Get a token. Send the Get Access Token request. The token is stored in your environment automatically and used by every other request.
- Run the health check. Send the Health Check request (
GET /v1/health).
| Variable | What to enter |
|---|---|
externalIntegratorId |
Your External Integration ID |
clientApplicationId |
Your Client Application ID |
apiSecret |
Your API Secret |
apiKey |
Your API Key |
apiScope |
The token scope, for example all |
apiUrl |
The base URL. Start with sandbox: https://public-api.sandbox.remitian.com |
What success looks like: the token request returns an access token, and the health check returns a successful response. That confirms your credentials, headers and environment are set up correctly.
Common questionsWhere do I find these values?
Your External Integration ID comes from onboarding. The Client Application ID, API Secret and API Key come from the Client Applications section of the Developer Portal.
The health check fails but the token request worked. What should I check?
Every request needs both the bearer token and the x-api-key header. Confirm apiKey is set, and that the token has not expired (tokens last 10 minutes by default, so request a new one).
The token request returns 401. Why?
Check the ID and secret for typos, and that you are using credentials for the environment in apiUrl. If your organization has an IP allowlist, a request from an unlisted IP also returns 401.
What should I do next?
Create your first firm. The Firms and firm users article explains why firms come first.
Full documentation