Vanta Crest

Developer Resources

API Reference

Baseline expectations for payload design, retries, and operator-safe integrations.

Request discipline

Integrations should be built around deterministic request construction, explicit validation, and stable identifiers. Implicit fallback logic creates long-term operational risk.

  • Validate payloads at the boundary before dispatch.
  • Use idempotency keys where operations can be replayed.
  • Treat reference fields as durable integration contracts.

Response handling

Client systems should classify success, retryable failure, and terminal failure cleanly. Avoid collapsing every non-200 into the same operator message.

  • Separate transport errors from business-rule failures.
  • Retain upstream identifiers for every accepted request.
  • Expose useful status copy to operators, not only raw codes.