Changelog

Breaking Changes

• The pending_removal attribute in the /v3/dids endpoint has been removed. It is replaced by the new billing_cycles_count attribute.

• The restriction message in the /v3/did_groups endpoint has been removed. It is now replaced by the requirements relationship.

Enhancements

• Introduced the billing_cycles_count attribute for the following:

  • In /v3/dids requests and responses, this attribute defines the number of billing cycles after which the DID will be terminated.

    • A value of null indicates the DID will renew indefinitely.

    • A value of 0 indicates the DID will not be renewed.

    • A positive integer value (e.g., 2) indicates the DID will be renewed that many times before termination. The value decreases by one after each renewal.

    • Accepted range: 0–999.

  • In /v3/orders, the items attribute for DID order items can now include billing_cycles_count to apply this configuration during DID creation.

• Added the address_verification relationship to the /v3/dids endpoint.

• Added support for callbacks attributes in the /v3/orders and /v3/cdr_export endpoints.

New Endpoints

Endpoint	Access Level
/v3/proof_types	Read
/v3/supporting_document_templates	Read
/v3/requirements	Read
/v3/identities	Read, Write, Delete
/v3/addresses	Read, Write, Delete
/v3/encrypted_files	Read, Write, Delete
/v3/proofs	Write, Delete
/v3/permanent_supporting_documents	Write, Delete
/v3/address_verifications	Read, Write
/v3/requirement_validations	Write

Note

For details on callback configuration, see the Callback Documentation Version 2021-04-19.