Loupe API

Resources

• Checks

  Check documents, see what was found and record the decision.

  • GET/loupe/checks
  • POST/loupe/checks
  • GET/loupe/checks/{check_id}
  • GET/loupe/checks/{check_id}/evidence
  • POST/loupe/checks/{check_id}/review
  • POST/loupe/checks/{check_id}/assign
  • POST/loupe/checks/{check_id}/folio
  • GET/loupe/checks/{check_id}/documents/{index}
  • GET/loupe/checks/{check_id}/documents/{index}/pages/{page}

• Policies

  Decide when a document goes to someone for review.

  • GET/loupe/policies
  • POST/loupe/policies
  • GET/loupe/policies/{name}

• Webhook endpoints

  Hear when a check finishes.

  • GET/loupe/webhooks
  • POST/loupe/webhooks
  • DELETE/loupe/webhooks/{webhook_id}

• Settings

  Where decided checks' documents are kept.

  • GET/loupe/settings
  • PUT/loupe/settings

All 42 Loupe schemas

Webhook events

• loupe.check.completed
• loupe.check.failed
• webhook.test