In order to retail Disabled Persons Railcards it has been mandated that a consistent and independent decision making service is used to asses and determine eligibility. The DMS API provides the following endpoints to enable retailers to interact with the decision making service, providing applications to them with associated documentation and providing an API endpoint, as specified below, for the DMS to call when a decision has been made.
Step One - upload files (optional)
This endpoint allows retailers to obtain a time-limited pre-signed URL which can then be used to upload a file to the DMS. Once uploaded the file details must be included when using the /submitApplication to request eligibility verification.
Step Two - submit application
The DMS API offers two methos to submit an application, depending on the retailers capabilities and preferences. A retailer only needs to use one of these methods
If the retailer chooses this option then they must first upload supporting documents using the /preSignedUrl endpoint
This endpoint allows retailers to submit eligibility application information along with associated object keys for documents previously uploaded using pre-signed URLs obtained from the /preSignedUrl endpoint.
- /submitApplicationExternalDocuments
This endpoint allows retailers to submit eligibility application information along with public URLs for documents not previously uploaded using a pre-signed URLs obtained from the /preSignedUrl endpoint.
Step Three - Eligibility decision
Once the decision making service has assessed an application they will confirm whether the applicant is eligible or not for a Disabled Persons Railcard. In order to communicate that decision the retailer must provide an API endpoint for the decision making service to call (known as a web hook).
In order for the eligibility decision to be successfully communicated that web hook must be defined as specified in the below endpoint.
- /caseResponseWebhookRequest
This web hook allows RDG to notify a retailer when a case decision has been made. As is the case with all web hooks, it depends on the retailer implementing an appropriate API for the web hook to call (see RSPS5231 for more details)