v1

latestOpenAPI 3.1.02026-07-1382339.6 KB

Onboarding

Create Client (Onboarding)

Onboard a new FHIR client (same endpoint for all client types). Generates ClientId and ClientSecret; ClientSecret is returned once. In Swagger, open Request body → Examples and choose FhirProvider (Agencies payload) or FhirPayer (Payer payload) to load the matching JSON.

post/v1/fhir-onboarding/client

Request body

ClientNamestring required

Name of the client

ClientType'FhirProvider' | 'FhirAggregator' | 'FhirThirdParty' | 'FhirPayer' required

Type of FHIR client (FhirProvider, FhirAggregator, FhirThirdParty, FhirPayer)

Descriptionstring nullable

Client description

Response

Successful Response

Messagestring required

Response message

Example response

{
  "Data": {
    "AgencyUsers": [
      {
        "AgencyId": 123,
        "Env": "app",
        "ProviderTaxId": "12-3456789",
        "RateLimit": 50,
        "RateLimitWindow": "Minute",
        "UserId": -6789,
        "UserName": "FHIRAPIUser_1_123"
      },
      {
        "AgencyId": 678,
        "Env": "app2",
        "RateLimit": 50,
        "RateLimitWindow": "Minute",
        "UserId": -4567,
        "UserName": "FHIRAPIUser_1_678"
      },
      {
        "AgencyId": 789,
        "Env": "cloud",
        "RateLimit": 100,
        "RateLimitWindow": "Second",
        "UserId": -8765,
        "UserName": "FHIRAPIUser_1_789"
      }
    ],
    "ClientId": "9b2f1a6e-3c84-4d8e-9b8a-7e2c9f2a1c45",
    "ClientName": "Client 1",
    "ClientSecret": "3f9c7a21-82b4-4c91-a8e7-6b4f2c9a1d78",
    "ClientType": "FhirProvider",
    "CreatedAt": "2026-01-12T07:45:30Z",
    "Description": "HHAx Client",
    "RateLimitingPlan": "Basic",
    "Status": "Active",
    "XApiKey": "brcRWv6qZQanfxwoZYvuYpMpfTUsvxEnkli2n998"
  },
  "Message": "Client onboarded successfully"
}

All 8 operations