API Reference
Log inSign up
v.1.7.2
v.1.7.2
  • Introduction
  • Integration
  • Sandbox and Live
  • Authentication
  • Rate Limits
  • Service Quota
  • Errors
  • Pagination
  • Filtering
  • Versioning
  • Core resources
  • Clients
    • Create a client
    • Get a client
    • Update a client
    • Delete a client
    • List clients
    • Filtering clients
  • Addresses
    • Create an address
    • Get an address
    • Update an address
    • Delete an address
    • List addresses
    • Filtering addresses
  • Documents
    • Create a document
    • Get a document
    • Update a document
    • Upload image attachment
    • Download image attachment
    • Delete image attachment
    • Delete a document
    • List documents
    • Filtering documents
  • Live Photos
    • Upload a live photo
    • Get a live photo
    • Download live photo
    • Delete a live photo
    • List live photos
  • Checks
    • Create a check
    • Get a check
    • Update a check
    • Validate check outcome
    • List checks
    • Filtering checks
  • Risk Profile
    • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
  • Other Resources
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • Reports
      • Generate a client report
      • Generate a check report
    • SDK Tokens
      • Generate a token
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
Powered by GitBook
On this page
  • Backwards compatibility
  • Changelog
  • v1.7.3
  • v1.7.2
  • v1.7.1
  • v1.7.0
  • v1.6.0
  • v1.5.0
  • v1.4.1
  • v1.4.0
  • v1.3.0
  • v1.2.2
  • v1.2.1
  • v1.2.0
  • v1.1.0
  • v1.0.1
  • v1.0.0

Was this helpful?

Versioning

PreviousFilteringNextClients

Last updated 4 years ago

Was this helpful?

Backwards compatibility

The following changes are considered backwards compatible:

  • Adding new API resources.

  • Adding new optional request parameters to existing API methods.

  • Adding new properties to existing API responses.

  • Changing the order of properties in existing API responses.

  • Changing the length or format of object IDs or other opaque strings.

  • Altering the message attributes returned by our errors.

  • Adding new webhooks event types. Your webhook listener should gracefully handle unfamiliar event types.

Changelog

v1.7.3

  • Additional webhook added.

v1.7.2

  • You can now use almost all attributes for .

v1.7.1

v1.7.0

v1.6.0

v1.5.0

v1.4.1

v1.4.0

v1.3.0

v1.2.2

v1.2.1

v1.2.0

v1.1.0

v1.0.1

v1.0.0

  • Initial release.

Added joinedDate to to allow for migrated clients.

Extended for .

Extended for .

Added more to the sandbox environment.

Introduced to API.

Added more to the sandbox environment.

can now generate a summary client report.

Additional country risk sources added to .

Added additional classifications for .

Introduced .

Added endpoint.

Added updatedAt to .

Added attribute telephone to .

Added calculated attribute entityName to .

Ability to create of the type company.

Introduced .

Added more types.

Added additional types.

clients
country coverage
Document Checks
list coverage
AML Screening Checks
test scenarios
Service Quota
test scenarios
Reports
Risk Profile
Documents
Risk Profile
tokens
checks
clients
clients
clients
Extensive AML Screening
error
address
filtering
event types