Get status

Check Application progress, signing acceptance and signed-file readiness.

Server request · private output

cURL

set +x
umask 077
: "${PAYLINE_API_BASE:?Use the trusted API base from Developer Settings}"
: "${PAYLINE_API_KEY:?Load your Test key through your secret manager}"
: "${APPLICATION_ID:?Use the ID from successful creation}"
curl --silent --show-error --fail-with-body --request GET \
  --url "$PAYLINE_API_BASE/applications/$APPLICATION_ID/status" \
  --header "Authorization: Bearer $PAYLINE_API_KEY" \
  --output status.json

200

unsigned

{ "applicationId": "a7d12cb4-2430-4e9d-a414-89fe4f52ee10", "status": "draft", "archivedAt": null, "ownerUserId": null, "assigneeUserId": null, "signing": { "accepted": false, "acceptedAt": null, "disposition": null }, "artifacts": { "state": "not_started", "versionId": null, "items": [] } }

Use this endpoint for polling without retrieving protected answers or a merchant completion URL. Read Application status, signing.accepted and artifacts.state separately. Signing remains accepted if file finalization fails; contradictory evidence is unavailable, not proof of readiness.

Poll with backoff and honor Retry-After on 429. GETs share the 120-attempt per-caller/60-second limit, including across key replacement. No query parameters are accepted. See status and artifact states.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

applicationId · string<uuid> · required

Response

200

application/json

Safe current lifecycle and immutable artifact metadata.

applicationId · string<uuid> · required

status · enum<string> · required

Available options: draft, in_progress, submitted, in_review, needs_information, pending, approved, declined, boarded, live, dormant, closed

archivedAt · string<date-time> | null · required

ownerUserId · string<uuid> | null · required

assigneeUserId · string<uuid> | null · required

signing · object · required

Show child attributes

artifacts · object · required

Show child attributes