Skip to content

Get document

View .md
GET

Get a specific regulatory document.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • documentIdstringrequired

Responses

200Document details.
  • documentobjectrequired

    A regulatory document for phone number requirements.

    9 properties
    • idstringrequired
    • namestringrequired
    • documentTypestringrequired
      One ofpassportnational_iddrivers_licenseutility_billtax_idbusiness_registrationproof_of_addressother
    • mimeTypestring
    • fileSizeinteger
    • statusstringrequired
      One ofpendinguploadedverifiedrejected
    • rejectionReasonstringnullable
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Document not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject