Skip to content
DashboardGet API key

Create document

View .md
POST

Create a regulatory document record after uploading the file. Use the upload-url endpoint first to get an upload URL.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Body

application/json

  • namestringrequired
    Limitsmax length 200
  • documentTypestringrequired
    One ofpassportnational_iddrivers_licenseutility_billtax_idbusiness_registrationproof_of_addressother
  • storageIdstringrequired

    Storage ID from the upload-url endpoint.

  • mimeTypestringrequired
  • fileSizeintegerrequired

Responses

201Document created and submitted for review.
  • 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>
400Invalid request or upload failed.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject