1. Getting Started
  2. Getting Started Guide

This guide will walk you through the process of setting up your account and making your first API request to the Remitian Public API.


​
Step 1: Request API Access

Account creation is currently managed through our support team to ensure secure onboarding.

To request access:

  1. Send an email to support@remitian.com
  2. Include the following information:
    • Your company name
    • Primary use case for the API
    • Expected integration timeline
    • Technical contact details

Response Time: Our support team typically responds within 1-2 business days.


​
Step 2: Sign Up to the Developer Portal

Once your access is aligned with our team, you’ll receive an email invitation to sign up to the Developer Portal. From there, everything is self-service: manage your credentials, team members, firm access, webhook configuration, and IP allowlist.

​
πŸ”‘ External Application ID

A unique identifier for your application in the Remitian platform, provided during onboarding.

​
πŸ”‘ Client Application Credentials

Create a Client Application in the Developer Portal to generate the credentials needed to authenticate your API requests:

  • Client ID
  • Client Secret
  • API Key

Self-Service Credentials: Credentials are generated, copied, and regenerated directly in the Developer Portal β€” they are never sent by email. Members with the Editor role can rotate them at any time.

Important: Store the Client Secret securely. Never commit it to version control or expose it in client-side code.


​
Step 3: Set Up Your Environment

​
Choose Your Environment

Remitian provides two environments for development and production:

EnvironmentPurposeBase URL
SandboxDevelopment & Testinghttps://public-api.sandbox.remitian.com
ProductionLive Applicationshttps://public-api.remitian.com

Tip: Always start with the Sandbox environment to test your integration before moving to Production.

Learn more in our Environments Guide.


​
Step 4: Authenticate Your Requests

All API requests require authentication using your credentials.

Authentication Steps:

  1. Use your Client Application credentials to authenticate
  2. Include the required authentication headers in your API requests
  3. Ensure your credentials are kept secure at all times

For detailed authentication instructions and examples, see our Authentication Guide.


​
Step 5: Make Your First API Request

​
Example: Health Check Endpoint

curl -X GET "https://public-api.sandbox.remitian.com/v1/health" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "x-api-key: YOUR_API_KEY"

​
Postman Collection

We provide a pre-configured Postman collection to help you get started quickly:

  1. Download our Postman Collection
  2. Import it into Postman
  3. Configure your credentials in the collection variables
  4. Start making requests

​
Try It in the API Reference

You can also call the endpoints without leaving the docs. Every page of the API Reference has a Try it panel that sends the request to Sandbox and shows the response.


​
Next Steps

Now that you’re set up, explore these resources:

  • 🌍 Environments - Understand sandbox vs production
  • πŸ“– Authentication - Detailed guide on securing your API requests
  • πŸ§ͺ Postman Collection - Test API endpoints interactively
  • πŸ€– Use the Docs with AI - Connect your AI assistant to these docs through MCP
  • πŸš€ Use Cases - Real-world integration scenarios with step-by-step examples
  • πŸ› οΈ Developer Portal - Manage credentials, webhooks, firm access, IP allowlisting, and your team
  • πŸ”” Webhooks - Receive real-time event notifications

​
Need Help?

Our support team is here to assist you:


Ready to build something amazing? Let’s get started! πŸš€