Check Eligibility

Changed on Sep 17, 2026

Initiates an eligibility check. Returns the metadata of the check if successfully initiated.

post/coverages/v1//{id}/eligibility

Request

Base URL
https://pre-api.joincandidhealth.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/joincandidhealth/apis/joincandidhealth/docs/coverages/v1/:id/eligibility/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

The unique identifier for a Coverage in the database

Request body

service_code'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '30' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '45' | '46' | '47' | '48' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '59' | '60' | '61' | '62' | '63' | '64' | '65' | '66' | '67' | '68' | '69' | '70' | '71' | '72' | '73' | '74' | '75' | '76' | '77' | '78' | '79' | '80' | '81' | '82' | '83' | '84' | '85' | '86' | '87' | '88' | '89' | '90' | '91' | '92' | '93' | '94' | '95' | '96' | '97' | '98' | '99' | 'A0' | 'A1' | 'A2' | 'A3' | 'A4' | 'A5' | 'A6' | 'A7' | 'A8' | 'A9' | 'AA' | 'AB' | 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AH' | 'AI' | 'AJ' | 'AK' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'B1' | 'B2' | 'B3' | 'BA' | 'BB' | 'BC' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BK' | 'BL' | 'BM' | 'BN' | 'BP' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BU' | 'BV' | 'BW' | 'BX' | 'BY' | 'BZ' | 'C1' | 'CA' | 'CB' | 'CC' | 'CD' | 'CE' | 'CF' | 'CG' | 'CH' | 'CI' | 'CJ' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CP' | 'CQ' | 'DG' | 'DM' | 'DS' | 'GF' | 'GN' | 'GY' | 'IC' | 'MH' | 'NI' | 'ON' | 'PT' | 'PU' | 'RN' | 'RT' | 'TC' | 'TN' | 'UC' required

Code identifying the type of service or benefit within a specific insurance policy (X12 008010 Element 1365)

date_of_servicestring date required

npistring required

Response

Response with status 200

check_idstring required

Code identifying the type of service or benefit within a specific insurance policy (X12 008010 Element 1365)

status'COMPLETED' | 'FAILED' | 'PENDING' required

enum to represent the status of an eligibility checks

initiated_bystring required

The unique identifier for a User in the database

initiated_atstring date-time required

Changes

Sep 17, 202624b2d80d577a Revision changes
- breaking
  request property was restricted to a list of enum values
- breaking
  the request property type changed from no type to string
- breaking
  the response's body type changed from no type to object for status
- warning
  deleted the header request parameter Authorization
- info
  the endpoint scheme security OAuthScheme was added to the API
- info
  for the path request parameter id, the type was generalized from no type to string, and format from no format to uuid
- info
  added the new 1 enum value to the request property
- info
  added the new 10 enum value to the request property
- info
  added the new 11 enum value to the request property
- info
  added the new 12 enum value to the request property
- info
  added the new 13 enum value to the request property
- info
  added the new 14 enum value to the request property
- info
  added the new 15 enum value to the request property
- info
  added the new 16 enum value to the request property
- info
  added the new 17 enum value to the request property
- info
  added the new 18 enum value to the request property
- info
  added the new 19 enum value to the request property
- info
  added the new 2 enum value to the request property
- info
  added the new 20 enum value to the request property
- info
  added the new 21 enum value to the request property
- info
  added the new 22 enum value to the request property
- info
  added the new 23 enum value to the request property
- info
  added the new 24 enum value to the request property
- info
  added the new 25 enum value to the request property
- info
  added the new 26 enum value to the request property
- info
  added the new 27 enum value to the request property
- info
  added the new 28 enum value to the request property
- info
  added the new 3 enum value to the request property
- info
  added the new 30 enum value to the request property
- info
  added the new 32 enum value to the request property
- info
  added the new 33 enum value to the request property
- info
  added the new 34 enum value to the request property
- info
  added the new 35 enum value to the request property
- info
  added the new 36 enum value to the request property
- info
  added the new 37 enum value to the request property
- info
  added the new 38 enum value to the request property
- info
  added the new 39 enum value to the request property
- info
  added the new 4 enum value to the request property
- info
  added the new 40 enum value to the request property
- info
  added the new 41 enum value to the request property
- info
  added the new 42 enum value to the request property
- info
  added the new 43 enum value to the request property
- info
  added the new 44 enum value to the request property
- info
  added the new 45 enum value to the request property
- info
  added the new 46 enum value to the request property
- info
  added the new 47 enum value to the request property
- info
  added the new 48 enum value to the request property
- info
  added the new 49 enum value to the request property
- info
  added the new 5 enum value to the request property
- info
  added the new 50 enum value to the request property
- info
  added the new 51 enum value to the request property
- info
  added the new 52 enum value to the request property
- info
  added the new 53 enum value to the request property
- info
  added the new 54 enum value to the request property
- info
  added the new 55 enum value to the request property
- info
  added the new 56 enum value to the request property
- info
  added the new 57 enum value to the request property
- info
  added the new 58 enum value to the request property
- info
  added the new 59 enum value to the request property
- info
  added the new 6 enum value to the request property
- info
  added the new 60 enum value to the request property
- info
  added the new 61 enum value to the request property
- info
  added the new 62 enum value to the request property
- info
  added the new 63 enum value to the request property
- info
  added the new 64 enum value to the request property
- info
  added the new 65 enum value to the request property
- info
  added the new 66 enum value to the request property
- info
  added the new 67 enum value to the request property
- info
  added the new 68 enum value to the request property
- info
  added the new 69 enum value to the request property
- info
  added the new 7 enum value to the request property
- info
  added the new 70 enum value to the request property
- info
  added the new 71 enum value to the request property
- info
  added the new 72 enum value to the request property
- info
  added the new 73 enum value to the request property
- info
  added the new 74 enum value to the request property
- info
  added the new 75 enum value to the request property
- info
  added the new 76 enum value to the request property
- info
  added the new 77 enum value to the request property
- info
  added the new 78 enum value to the request property
- info
  added the new 79 enum value to the request property
- info
  added the new 8 enum value to the request property
- info
  added the new 80 enum value to the request property
- info
  added the new 81 enum value to the request property
- info
  added the new 82 enum value to the request property
- info
  added the new 83 enum value to the request property
- info
  added the new 84 enum value to the request property
- info
  added the new 85 enum value to the request property
- info
  added the new 86 enum value to the request property
- info
  added the new 87 enum value to the request property
- info
  added the new 88 enum value to the request property
- info
  added the new 89 enum value to the request property
- info
  added the new 9 enum value to the request property
- info
  added the new 90 enum value to the request property
- info
  added the new 91 enum value to the request property
- info
  added the new 92 enum value to the request property
- info
  added the new 93 enum value to the request property
- info
  added the new 94 enum value to the request property
- info
  added the new 95 enum value to the request property
- info
  added the new 96 enum value to the request property
- info
  added the new 97 enum value to the request property
- info
  added the new 98 enum value to the request property
- info
  added the new 99 enum value to the request property
- info
  added the new A0 enum value to the request property
- info
  added the new A1 enum value to the request property
- info
  added the new A2 enum value to the request property
- info
  added the new A3 enum value to the request property
- info
  added the new A4 enum value to the request property
- info
  added the new A5 enum value to the request property
- info
  added the new A6 enum value to the request property
- info
  added the new A7 enum value to the request property
- info
  added the new A8 enum value to the request property
- info
  added the new A9 enum value to the request property
- info
  added the new AA enum value to the request property
- info
  added the new AB enum value to the request property
- info
  added the new AC enum value to the request property
- info
  added the new AD enum value to the request property
- info
  added the new AE enum value to the request property
- info
  added the new AF enum value to the request property
- info
  added the new AG enum value to the request property
- info
  added the new AH enum value to the request property
- info
  added the new AI enum value to the request property
- info
  added the new AJ enum value to the request property
- info
  added the new AK enum value to the request property
- info
  added the new AL enum value to the request property
- info
  added the new AM enum value to the request property
- info
  added the new AN enum value to the request property
- info
  added the new AO enum value to the request property
- info
  added the new AQ enum value to the request property
- info
  added the new AR enum value to the request property
- info
  added the new B1 enum value to the request property
- info
  added the new B2 enum value to the request property
- info
  added the new B3 enum value to the request property
- info
  added the new BA enum value to the request property
- info
  added the new BB enum value to the request property
- info
  added the new BC enum value to the request property
- info
  added the new BD enum value to the request property
- info
  added the new BE enum value to the request property
- info
  added the new BF enum value to the request property
- info
  added the new BG enum value to the request property
- info
  added the new BH enum value to the request property
- info
  added the new BI enum value to the request property
- info
  added the new BJ enum value to the request property
- info
  added the new BK enum value to the request property
- info
  added the new BL enum value to the request property
- info
  added the new BM enum value to the request property
- info
  added the new BN enum value to the request property
- info
  added the new BP enum value to the request property
- info
  added the new BQ enum value to the request property
- info
  added the new BR enum value to the request property
- info
  added the new BS enum value to the request property
- info
  added the new BT enum value to the request property
- info
  added the new BU enum value to the request property
- info
  added the new BV enum value to the request property
- info
  added the new BW enum value to the request property
- info
  added the new BX enum value to the request property
- info
  added the new BY enum value to the request property
- info
  added the new BZ enum value to the request property
- info
  added the new C1 enum value to the request property
- info
  added the new CA enum value to the request property
- info
  added the new CB enum value to the request property
- info
  added the new CC enum value to the request property
- info
  added the new CD enum value to the request property
- info
  added the new CE enum value to the request property
- info
  added the new CF enum value to the request property
- info
  added the new CG enum value to the request property
- info
  added the new CH enum value to the request property
- info
  added the new CI enum value to the request property
- info
  added the new CJ enum value to the request property
- info
  added the new CK enum value to the request property
- info
  added the new CL enum value to the request property
- info
  added the new CM enum value to the request property
- info
  added the new CN enum value to the request property
- info
  added the new CO enum value to the request property
- info
  added the new CP enum value to the request property
- info
  added the new CQ enum value to the request property
- info
  added the new DG enum value to the request property
- info
  added the new DM enum value to the request property
- info
  added the new DS enum value to the request property
- info
  added the new GF enum value to the request property
- info
  added the new GN enum value to the request property
- info
  added the new GY enum value to the request property
- info
  added the new IC enum value to the request property
- info
  added the new MH enum value to the request property
- info
  added the new NI enum value to the request property
- info
  added the new ON enum value to the request property
- info
  added the new PT enum value to the request property
- info
  added the new PU enum value to the request property
- info
  added the new RN enum value to the request property
- info
  added the new RT enum value to the request property
- info
  added the new TC enum value to the request property
- info
  added the new TN enum value to the request property
- info
  added the new UC enum value to the request property
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Sep 12, 20263a81ee81d4ed Revision changes
- info
  api operation id check_eligibility removed and replaced with v1_check_eligibility

Operation history