Skip to main content
GET
/
api
/
v1
/
form_deliveries
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "active": true,
  "address": "<string>",
  "authorization_form": {
    "id": "<string>",
    "created_at": "<string>",
    "document_url": "<string>",
    "expires_at": "<string>",
    "form_name": "<string>",
    "form_type": "<string>",
    "is_valid": true,
    "sent_at": "<string>",
    "signed_at": "<string>",
    "status": "pending",
    "updated_at": "<string>"
  },
  "can_be_revoked": true,
  "channel": "fax",
  "confirmation_channel": "phone_call",
  "confirmation_notes": "<string>",
  "confirmation_required": true,
  "confirmation_retry_count": 123,
  "confirmed_at": "<string>",
  "created_at": "<string>",
  "cross_channel_confirmation": true,
  "days_until_expiration": 123,
  "delivered_at": "<string>",
  "expired": true,
  "expires_at": "<string>",
  "expiring_soon": true,
  "external_id": "<string>",
  "form_type": "<string>",
  "meets_requirement": true,
  "metadata": {},
  "recipient_name": "<string>",
  "recipient_type": "<string>",
  "revocation_discovered_via": "phone_call",
  "revocation_reason": "<string>",
  "revoked_at": "<string>",
  "sent_at": "<string>",
  "status": "pending",
  "suggested_follow_up_date": "<string>",
  "updated_at": "<string>"
}

Path Parameters

id
string
required

Response

OK

id
string
required
active
boolean
required
address
string
required
authorization_form
object
required
can_be_revoked
boolean
required
channel
enum<string>
required
Available options:
fax,
email,
mail,
portal
confirmation_channel
enum<string> | null
required
Available options:
phone_call,
email_response,
portal_check,
in_person,
other
confirmation_notes
string | null
required
confirmation_required
boolean
required
confirmation_retry_count
integer
required
confirmed_at
string
required
created_at
string
required
cross_channel_confirmation
boolean
required
days_until_expiration
integer
required
delivered_at
string
required
expired
boolean
required
expires_at
string
required
expiring_soon
boolean
required
external_id
string
required
form_type
string
required
meets_requirement
boolean
required
metadata
object
required
recipient_name
string
required
recipient_type
string
required
revocation_discovered_via
enum<string> | null
required
Available options:
phone_call,
email_response,
portal_check,
in_person,
other
revocation_reason
string | null
required
revoked_at
string | null
required
sent_at
string
required
status
enum<string>
required
Available options:
pending,
sent,
delivered,
confirmed,
failed,
expired,
revoked
suggested_follow_up_date
string | null
required
updated_at
string
required