Postman Collection

Download the ready-made Postman collection to test the IB Partner API without any manual setup.

⬇ Download Postman Collection

---

What's included

The collection comes pre-configured with five variables so you can get started immediately:

Variable	Default value	Description
baseUrl	https://your-domain.com	Your API base URL
apiKey	ib_live_your_api_key_here	Your Partner API key
userId	a1b2c3d4-0000-0000-0000-000000000000	The user ID to look up
email	user@example.com	The user email to verify
referenceId	a1b2c3d4-0000-0000-0000-000000000000	The deposit reference ID to check

How to use

1. Download the collection file above.
2. Open Postman → click Import → select the file.
3. Go to Variables and update the variables with your real values:
   • baseUrl → your actual domain
   • apiKey → your Partner API key
   • userId → a real user ID to check
   • email → a real user email to verify
   • referenceId → a real deposit reference ID to check
4. Run the Get User Status, Get User Status With Email, or Check Deposit request.

Included requests

Get User Status

Checks whether a user belongs to your IB.

• Method: GET
• URL: {{baseUrl}}/api/ib/user-status?user_id={{userId}}
• Header: Authorization: Bearer {{apiKey}}

Get User Status With Email

Checks whether a user belongs to your IB, verified by ID and email.

• Method: GET
• URL: {{baseUrl}}/api/ib/user-status-with-email?user_id={{userId}}&email={{email}}
• Header: Authorization: Bearer {{apiKey}}

Check Deposit

Checks whether a child user's deposit has been executed and retrieves its amount.

• Method: GET
• URL: {{baseUrl}}/api/ib/deposit-check?reference_id={{referenceId}}
• Header: Authorization: Bearer {{apiKey}}