Overview
This guide will walk you through the initial setup required to integrate your organization with the Barid platform.
Prerequisites
Before you begin, ensure you have:
- A registered organization in the UAE
- Valid contact information (email, phone)
- Required documentation for sender verification
- Technical resources for integration (for API or Email methods)
Integration Journey
1. Registration
Register your organization as a verified Barid sender. This process includes:
- Submitting organization details
- Providing verification documentation
- Setting up your sender profile (logo, company information)
- Receiving sender credentials
2. Choose Your Integration Method
Select the integration approach that best fits your technical capabilities:
| Method | Best For | Technical Complexity |
|---|---|---|
| API Integration | Automated systems, high volume, full control | Medium-High |
| Sender Client | Manual processing, small volumes, testing | Low |
| Email Integration | Legacy systems with email-only workflows | Low |
3. Authentication Setup
Configure authentication based on your chosen method:
- API: API key authentication
- Sender Client: User credentials and two-factor authentication
- Email: DKIM and SPF verification (fallback option)
4. Testing
Test your integration in the Staging environment before going live:
- Send test letters to verified test users
- Validate letter formatting and metadata
- Confirm delivery notifications
- Review error handling
5. Review Process
All letters and invoices submitted through Barid undergo a review process:
- Barid reviews all incoming content for compliance and quality
- Review is completed within 12 hours of submission
- Once approved, letters/invoices are instantly available to end users
- You will be notified of the approval or rejection status
This ensures all correspondence meets quality standards and complies with UAE regulations.
6. Production Deployment
Once testing is complete:
- Switch to production credentials
- Configure production endpoints
- Set up monitoring and alerting
- Review compliance requirements
Next Steps
- Register your organization
- Set up authentication
- Send your first test letter
- Review best practices
- Understand end user access
Environment Endpoints
Staging Environment
- Sender API:
https://qa.sender.api.barid.ae - Inbound Email:
qa.inbound.barid.ae - Sender Client:
https://qa.sender.barid.ae - User Client:
https://qa.app.barid.ae
Production Environment
- Sender API:
https://sender.api.barid.ae - Inbound Email:
inbound.barid.ae - Sender Client:
https://sender.barid.ae - User Client:
https://app.barid.ae