Skip to content

Get Authorization

Retrieve a single authorization record by its authorization ID.

Endpoint

GET /apis/soap-enrichment/v1/authorization/{authorizationId}

Path Parameters

Parameter Type Required Description
authorizationId string Yes The unique ID of the authorization record

Request

curl --location '{base_url}/apis/soap-enrichment/v1/authorization/auth_69cd0c97abc123' \
  --header 'Authorization: Bearer JWT_TOKEN'

Response

Success Response

Code: 200 OK

{
  "code": 2000,
  "data": {
    "authorization_id": "auth_69cd0c97abc123",
    "authorization_reference_number": "AUTH-2026-001",
    "spry_case_id": "SPRY_CASE_69cd0c97e7562d613ea89bc7",
    "case_title": "Stable Burst Fracture",
    "plan_start_date": "2026-04-01T00:00:00",
    "plan_end_date": "2026-07-01T00:00:00",
    "effective_start_date": "2026-04-01T00:00:00",
    "effective_end_date": "2026-07-01T00:00:00",
    "insurance_payer": {
      "payer_reg_id": 2207,
      "name": "PEHP - Utah Public Employee Health Plan",
      "payer_id": "SX106",
      "payer_type": "COMMERCIAL"
    },
    "authorized_visit_count": 20,
    "current_visit_count": 5,
    "previous_consumed_visit_count": 0,
    "final_consumed_visit_count": 5,
    "phone_number": "8015551234",
    "fax_number": "8015555678",
    "comments": "Prior auth approved for MSK therapy",
    "authorization_status": "ACTIVE",
    "patient_id": 1172416,
    "patient_name": "John Doe",
    "organisation_id": 638,
    "clinic_id": 101,
    "icd_codes": [
      {
        "id": 9676,
        "code": "M72.1",
        "description": "Knuckle pads",
        "revision": "ICD10"
      }
    ],
    "cpt_code_authorization_details": [],
    "created_at": "2026-04-01T12:00:00",
    "updated_at": "2026-04-10T09:30:00",
    "created_date": "2026-04-01T12:00:00Z"
  },
  "message": "Success"
}

Response Fields

Field Type Description
authorization_id string Unique identifier for the authorization record
authorization_reference_number string Payer-issued authorization reference number
spry_case_id string Associated Spry case ID
case_title string Title of the associated case
plan_start_date string Insurance plan start date
plan_end_date string Insurance plan end date
effective_start_date string Authorization effective start date
effective_end_date string Authorization effective end date
insurance_payer object Payer details (payer_reg_id, name, payer_id, payer_type)
authorized_visit_count integer Total visits authorized by the payer
current_visit_count integer Visits consumed in the current authorization period
previous_consumed_visit_count integer Visits consumed in prior authorization periods
final_consumed_visit_count integer Total visits consumed (current + previous)
phone_number string Payer contact phone
fax_number string Payer contact fax
comments string Free-text notes
authorization_status string ACTIVE, INACTIVE, or EXPIRED
patient_id integer Patient ID
patient_name string Patient full name
organisation_id integer Organization ID
clinic_id integer Clinic ID
icd_codes array ICD-10 codes covered by this authorization
cpt_code_authorization_details array Per-CPT-code authorization limits
created_at string Creation timestamp
updated_at string Last update timestamp
created_date string Creation timestamp (ISO 8601 with timezone)

Error Response

Code: 200 OK

{
  "code": 4004,
  "data": null,
  "message": "Authorization not found"
}