Daybook DocsDaybook Docs
Book a demo
Browse
Book a demo

Start a portal task

POST/v1/portal-tasks

Have Daybook sign in to a payer portal, run a defined set of steps and read the result back.

Used in Payer portals1 use case

Call this with AIA brief with this endpoint's request, response and auth, ready for a typed client in your language.

Body

  • payerstringrequired
    Daybook payer id.
  • taskstringrequired
    remit_lookup, claim_lookup, appeal_status, attachment_upload or overpayment_lookup.
  • portalstring
    Force a portal. By default Daybook picks the portal that answers the task for this payer.
  • claimobject
    The claim the task is about.
    Properties
    • payer_claim_numberstring
      The payer's claim number (ICN), when you have it.
    • patient_control_numberstring
      Your claim id as sent in CLM01.
    • date_of_servicestringrequired
      First date of service, YYYY-MM-DD.
    • billed_amount_centsinteger
      Total billed, in cents.
  • providerobjectrequired
    The provider whose portal account to use.
    Properties
    • npistringrequired
      Billing or rendering NPI.
    • tax_idstring
      Tax id, when the payer verifies by TIN.
  • attachment_urlstring
    For attachment_upload: an HTTPS link Daybook fetches the file from.
  • require_approvalboolean
    Hold any step that changes something in the portal until you approve it. Defaults to true for attachment_upload.
  • metadataobject
    Your keys, echoed back.
Try itEdit the fields and copy the request. Nothing is sent from this page.
curl -X POST https://api.daybookhealthcare.com/v1/portal-tasks \
  -H "Authorization: Bearer $DAYBOOK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "payer": "keystone",
    "task": "remit_lookup",
    "claim": {
      "patient_control_number": "A-20817-1",
      "date_of_service": "2026-09-30"
    },
    "provider": {
      "npi": "1999999984",
      "tax_id": "00-0000000"
    }
  }'

Response

  • idstring
    Unique id, prefixed ptask_.
  • objectstring
    Always portal_task.
  • statusstring
    queued, running, approval_required, completed, failed or canceled.
  • payerstring
    Daybook payer id.
  • portalstring
    The portal used, such as availity or the payer's own site.
  • taskstring
    The task you asked for.
  • pending_actionobject
    What Daybook is about to change in the portal. Present while approval_required.
    Properties
    • summarystring
      The change, in plain words.
    • screenshot_urlstring
      Signed link to the screen as it will be submitted.
  • resultobject
    What Daybook read back. Shape depends on task. null until completed.
  • evidenceobject[]
    Signed links to the pages captured along the way.
  • metadataobject
    Your keys, echoed back.
  • created_atstring
    RFC 3339 timestamp.
curl -X POST https://api.daybookhealthcare.com/v1/portal-tasks \
  -H "Authorization: Bearer $DAYBOOK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "payer": "keystone",
    "task": "remit_lookup",
    "claim": {
      "patient_control_number": "A-20817-1",
      "date_of_service": "2026-09-30"
    },
    "provider": {
      "npi": "1999999984",
      "tax_id": "00-0000000"
    }
  }'
Response 200
{
  "id": "ptask_01JBXA2W8K3N",
  "object": "portal_task",
  "status": "queued",
  "payer": "keystone",
  "portal": "availity",
  "task": "remit_lookup",
  "pending_action": null,
  "result": null,
  "evidence": [],
  "metadata": {},
  "created_at": "2026-10-29T15:10:40Z"
}