Added

0.19.6 Bring your own member IDs with externalId

You can now attach your own identifier to a member and get it back on every read — no more keeping a mapping table between your system's IDs and ours.

externalId on application bundles

When submitting an application bundle, set externalId on the PolicyHolder applicant:

{
  "applicants": [
    {
      "personDetailsType": "PolicyHolder",
      "externalId": "EMP-10042",
      "...": "..."
    }
  ]
}
  • Your own identifier for the person — an employee number, HRIS ID, or order ID.
  • Up to 255 characters, must be unique within your company.
  • Only allowed on the PolicyHolder applicant — submitting one on a dependant returns 400.

The value is returned unchanged wherever the person appears:

  • GET /application-bundles/{id} and the application-bundle listing — on the applicant.
  • GET /contract-bundles — on the contract holder, so you can correlate live policies with your records. Policyholders without one return externalId: null.

Stricter ownership checks on read endpoints

Read endpoints that accept a companyContractId now verify the contract belongs to your company. Requests referencing another company's contract return 404 instead of an empty result. No change is needed if you only pass your own contract IDs.