The National Benefit Schemas

 

The National Benefits Schemas are a set of open standard based APIs that enable digital solution providers to integrate their services directly into the line of business back office benefit processing systems such as Capita, Civica and Northgate. 

These APIs enable (but not limited to) the following with back office benefit systems:

  • Searching of the back office application to find people and their benefit claim references/statuses (PersonSearch API)
  • Searching of the back office application to find property details (PropertySearch API)
  • Retrieval of the entirety of a benefit claim's details (ClaimDetail API)
  • The posting of a new benefit claim directly into the benefits system (NBP_HB_CTB_Application API)
  • The posting of changes in circumstances directly into the benefits system (ChangeInCircumstances API)
  • The posting of the content of a claim or change in circumstances document (PDF) into an EDMS / Workflow application in an encoded format within an XML file for translation upon receipt (GenericClaim API)
  • The posting of evidence directly into an EDMS / Workflow application in an encoded format within an XML file for translation upon receipt (GenericClaim API)

As custodians IEG4 will curate and make necessary updates in collaboration with other digital/back office service providers as a part of the National Benefit Schema Consortium. As legislation has not necessitated changes to these for some years meetings have not been necessary. 

However, any organisations wishing to suggest enhancements can do so and these changes will be relayed to all interested parties prior to being published. To allow for organisations to take advantage of enhancements to schemas they will be updated at most in October or April of a given year in line with when benefit legislation is traditionally changed. At IEG4 we would be delighted to hear suggestions for changes and it is important to note that any changes made will always be in the form of optional elements, as ensuring backward compatibility is critical to any enhancements made.

To enable organisations to see the documentation and to communicate, we have just created a new Slack area, which is open for use and has two channels:

- XSDs

- API High Level Docs

With the former holding the actual schemas themselves and the latter containing details on versioning and the changes made over time. 

Access the Slack Channels