Home

Welcome to the hmpps-book-secure-move-api wiki!

Key Sections

• API Guide - the starting point for information on how to use the Book a Secure Move API
• Version 2 - the changes to the API as part of V2
• Asked Questions
• Webhook & Email notifications
• Walkthroughs - guidance on specific API use cases
• Deployment
• Useful Queries
• Data quality improvements
• Journeys and Payment Related Calls - management of Journeys
  • Single journey move
  • Redirection before move commences
    • Journey created before redirection
    • Journey created after redirection
  • Redirection after move commences
    • Redirection when the supplier is not at fault
    • Redirection when the supplier is at fault
• Lockouts and Lodgings
  • Creating a move lockout
• Assessments - details on supported Framework Assessments
  • Person Escort Record
  • Youth Risk Assessment
• Event Documentation
  • Move Events
  • Journey Events
  • Person Escort Record Events
  • Incident Events
  • Lodging Events
• GPS Track a move