Licenses

List all licenses

Returns a paginated list of all license records for your company. Use the state, status, license_type, and verified query parameters to filter results. Results are ordered by state code ascending.

get/licenses

Request

Base URL
https://app.payna.com/api/v1
URL
https://app.payna.com/api/v1/licenses
Auth
HTTP bearer

Query parameters

statestring

Comma-separated 2-letter state codes. Example: CA,NY,TX

statusstring

Comma-separated status values. Example: active,pending

license_typestring

Filter by license type (partial match). Example: Money Transmission

verifiedboolean

Filter by verification status. true or false.

pageinteger

Page number. Starts at 1.

limitinteger

Results per page. Max 200.

Response

Successful response.

Example response

{
  "data": [
    {
      "state_code": "CA",
      "license_type": "California - DFPI Debt Collection License",
      "activity_type": "debt_collection",
      "license_number": "CCA-2671499",
      "nmls_id": "2671499",
      "regulator": "DFPI",
      "sub_status": "withdrawn",
      "raw_status": "Approved-Active",
      "issued_date": "2023-06-15",
      "renewal_date": "2026-12-31",
      "days_until_renewal": 168,
      "jurisdiction_level": "state",
      "filing_method": "nmls",
      "status_detail": {
        "code": "voluntary_withdrawal",
        "label": "Withdrawn — voluntary",
        "portal": {
          "name": "Delaware One Stop",
          "url": "https://onestop.delaware.gov/Account_SignIn"
        },
        "source_text": "Withdrawn - Voluntary Without Licensure"
      }
    }
  ],
  "meta": {
    "total": 18,
    "page": 1,
    "limit": 50
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.