Change Updates

Do not miss any Verify API changes, ever again

Subscribe to the Verify API changelog to be up to date on recent changes.

RSS

May 24, 2022

main
1.29.1
Compare
1.29.1

API structure has changed

Next Change
26 structure changes including:
3 Additions
23 Modifications
Modified 23 Breaking
POST /v2/Services/{Sid}
  • Body
  • content type Modified
    • DefaultTemplateSid property Added
  • Response
  • 200 response Modified
    • push, totp properties Modified
    • default_template_sid property Added
POST /v2/Services/{ServiceSid}/Webhooks/{Sid}
  • Body
  • content type Modified
    • Version property Added
  • Response
  • 200 response Modified
    • version property Added
POST /v2/Services/{ServiceSid}/Webhooks
  • Body
  • content type Modified
    • Version property Added
  • Response
  • 201 response Modified
    • version property Added
POST /v2/Services/{ServiceSid}/Verifications/{Sid}
  • Response
  • 200 response Modified
    • lookup, send_code_attempts properties Modified
POST /v2/Services/{ServiceSid}/Verifications
  • Body
  • content type Modified
    • ChannelConfiguration, RateLimits properties Modified
    • TemplateCustomSubstitutions, TemplateSid properties Added
  • Response
  • 201 response Modified
    • lookup, send_code_attempts properties Modified
POST /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
  • Body
  • content type Modified
    • Config.NotificationPlatform property Added
  • Response
  • 200 response Modified
    • config property Modified
    • metadata property Added
POST /v2/Services/{ServiceSid}/Entities/{Identity}/Factors
  • Body
  • content type Modified
    • Metadata property Added
  • Response
  • 201 response Modified
    • binding, config properties Modified
    • metadata property Added
POST /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}
  • Body
  • content type Modified
    • Metadata property Added
  • Response
  • 200 response Modified
    • details, hidden_details properties Modified
    • metadata property Added
POST /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges
  • Body
  • content type Modified
    • Details.Fields, HiddenDetails properties Modified
  • Response
  • 201 response Modified
    • details, hidden_details properties Modified
    • metadata property Added
POST /v2/Services/{ServiceSid}/AccessTokens
  • Body
  • content type Modified
    • FactorFriendlyName, Ttl properties Added
  • Response
  • 201 response Modified
    • account_sid, date_created, entity_identity, factor_friendly_name, factor_type, service_sid, sid, ttl, url properties Added
POST /v2/Services
  • Body
  • content type Modified
    • DefaultTemplateSid property Added
  • Response
  • 201 response Modified
    • push, totp properties Modified
    • default_template_sid property Added
GET /v2/Services/{Sid}
  • Response
  • 200 response Modified
    • push, totp properties Modified
    • default_template_sid property Added
GET /v2/Services/{ServiceSid}/Webhooks/{Sid}
  • Response
  • 200 response Modified
    • version property Added
GET /v2/Services/{ServiceSid}/Webhooks
  • Response
  • 200 response Modified
    • webhooks property Modified
GET /v2/Services/{ServiceSid}/Verifications/{Sid}
  • Response
  • 200 response Modified
    • lookup, send_code_attempts properties Modified
GET /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
  • Response
  • 200 response Modified
    • config property Modified
    • metadata property Added
GET /v2/Services/{ServiceSid}/Entities/{Identity}/Factors
  • Response
  • 200 response Modified
    • factors property Modified
GET /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}
  • Response
  • 200 response Modified
    • details, hidden_details properties Modified
    • metadata property Added
GET /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges
  • Response
  • 200 response Modified
    • challenges property Modified
  • Query
  • Order query parameter Added
GET /v2/Services
  • Response
  • 200 response Modified
    • services property Modified
GET /v2/Forms/{FormType}
  • Response
  • 200 response Modified
    • form_meta, forms properties Modified
GET /v2/Attempts/{Sid}
  • Response
  • 200 response Modified
    • channel_data property Modified
    • price, verification_sid properties Added
GET /v2/Attempts
  • Response
  • 200 response Modified
    • attempts property Modified
  • Query
  • Country, Channel, VerifyServiceSid, VerificationSid, Status query parameters Added
Added 3
GET /v2/Templates
GET /v2/Services/{ServiceSid}/AccessTokens/{Sid}
GET /v2/Attempts/Summary