Partner API v1

Submit patient demographic and scheduling data

Submit patient demographic and scheduling data.

Enhanced Functionality: This endpoint now supports combined payloads including:

  • Contact data (required)
  • Medications data (optional)
  • Outreach data (optional)
  • Related persons data (optional) — list of people associated with the patient (e.g., emergency contacts, caregivers)

All processing is synchronous - responses are returned immediately without waiting for pipeline processing.

Data Processing: Submitted patient data is fully processed and validated before a response is returned. If any step of patient data processing fails, the contact will be marked as failed in the response.

Authentication: This endpoint supports dual authentication methods:

  • Auth0 JWT Bearer Token: For partners using Auth0 authentication

    • Header: Authorization: Bearer <JWT_TOKEN>
    • Token must include partner_id claim
    • Token is validated for signature, expiration, issuer, and audience
  • Verification Token: For partners using legacy authentication

    • Header: verification-token: <ENCRYPTED_TOKEN>
    • Token format: partner_id:verification_token (encrypted)
    • Validated against partner credentials

Your partner account is configured for one of these methods. Please use the authentication method assigned to your account. If you attempt to use the wrong method, you will receive a 401 Unauthorized error.

Response Codes:

  • 201 Created: Successfully processed contact data (contact-only requests)
  • 200 OK: Successfully processed combined payload (contact + medications/outreach)
  • 207 Multi-Status: Partially successful (some contacts/medications/outreach failed)
  • 401 Unauthorized: Authentication failed or wrong authentication method used
  • 400 Bad Request: Invalid request payload
  • 500 Internal Server Error: Server error during processing
post/api/v1/contacts

Request

  • Base URL
    https://api.hippocraticai.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.