Partnership API Documentation
  1. API Integration
Partnership API Documentation
  • Introduction
  • API Integration
    • Overview
    • Flowchart
    • Authentication
    • Participant Criteria
    • Publish Study
    • Get Criteria
      GET
    • Publish Study
      POST
    • Get Study Details
      GET
    • Update Study Status
      PATCH
    • Download Report
      GET
  • iFrame Integration
    • Overview
    • Request Token
      POST
    • Get Studies
      GET
  1. API Integration

Authentication

To access the Partnership API, you must include a valid API key in the request header. This API key authenticates your request and ensures that only authorized users can interact with the API. The key is provided to you upon registration.
How to Authenticate
Include the API Key in the Authorization header for every request:
Authorization: Api-Key {API_KEY}
Before you can access the API, ensure that your IP address is whitelisted by INFRA for security purposes. Once whitelisted, all requests from your IP will be accepted.
Security Considerations
API Key: The API key should be kept confidential and shared only with authorized parties.
IP Whitelisting: Your IP address must be added to the whitelist to access the API.
Logging: All API usage should be logged for security and monitoring purposes.
Modified at 2025-08-20 10:06:14
Previous
Flowchart
Next
Participant Criteria
Built with