Docs Rizler

Carrier application

Get Carrier Application

GEThttps://app.rizzdial.com/api/sipnex/application
Get Carrier Application
curl --request GET \
  --url https://app.rizzdial.com/api/sipnex/application \
  --header 'Authorization: Bearer <token>'
{
  "needs": [],
  "status": "in_review",
  "company": {
    "ein": "12-3456789",
    "zip": "78701",
    "city": "Austin",
    "state": "TX",
    "entity": "LLC",
    "street": "100 Main St",
    "website": "https://example.com",
    "legal_name": "Example LLC"
  },
  "preview": [
    {
      "items": [
        {
          "link": false,
          "wide": false,
          "label": "Legal name",
          "value": "Example LLC"
        }
      ],
      "title": "Company"
    }
  ],
  "success": true,
  "can_send": true,
  "reference": "APP-1001",
  "submitted": true,
  "status_label": "In review",
  "company_ready": true,
  "document_kinds": {
    "id": "Driver's license",
    "ein": "IRS EIN letter",
    "other": "Other document",
    "incorp": "Proof of incorporation",
    "consent": "Consent screenshots"
  },
  "request_message": null
}

Get Carrier Application#

Returns the signed-in company's Carrier application: whether it is submitted, status, reference, company fields from the default business profile, and (after submit) a preview of what was sent.

Anyone with a token can read this. can_send is true only for the account owner or an admin.

Authorizationstringheaderrequired

Bearer token in the format: Bearer {access_token}

curl --request GET \
  --url https://app.rizzdial.com/api/sipnex/application \
  --header 'Authorization: Bearer {{bearer_token}}'
successboolean

true

submittedboolean

true after a successful submit (a reference exists)

can_sendboolean

true if this user may submit or send requested files

company_readyboolean

true when the default business profile has legal name, EIN, entity, street, city, 2-letter state, and ZIP

companyobject

legal_name, ein, entity, street, city, state, zip, website from the default business profile

referencestring

Application reference after submit. null if not submitted

statusstring

uploading, new, in_review, info_requested, approved, declined, or live. null if not submitted

status_labelstring

Waiting for documents, Submitted, In review, More information needed, Approved, Declined, or Live

needsarray

File kinds still requested when status is info_requested: id, incorp, consent, ein, other. Empty otherwise. Use these as file_{kind} on Send Files

request_messagestring

Note from review when more files are needed. null otherwise

document_kindsobject

Labels for kinds: id (driver's license), incorp, consent, ein, other

previewarray

After submit: sections (Company, How the numbers will be used, Compliance, Documents and signature) with items (label, value, wide, link). Empty array if not submitted