NIR API Test Data
Find out how to connect to the NIR API Integration Testing Environment and browse guidance and specific test patients for completing onboarding testing.
Pre-requisites
Access to the INT (integration) Testing environment is not automatically provided as part of DOS accreditation. To begin INT environment testing, your product version must first be fully accredited via DOS. Once accredited and the Connection Agreement is signed, an NHS end user organisation (EUO) must formally commission you and provide their Home Community ID.
You may then proceed to complete the below pre-requisite steps in order to make successful requests to NIR and submit your onboarding test evidence.
Consumers
- Outbound Connectivity - ensure you can reach our domain over the internet (https://int.nir.national.nhs.uk)
- NIR Allow List - provide the static IP address(es) of your service to be added to the NIR allow list
- Certificates - provide your public certificate for us to add to our truststore. Note: it is best practice to regularly rotate the leaf certificate and key you use for mTLS and WS-Security (XUA SAML Assertions)
Unlike the Sandbox, the INT environment requires XUA SAML and WS-Security within the request. It may be helpful to refer to our XUA SAML and WS-Security guide when implementing this.
Providers
- Inbound Connectivity - allow inbound access from the NIR INT static outbound IP address: 13.42.167.103
- Responding Gateway Service Endpoints - provide your service endpoints for any of the profiles you are exposing to the NIR team (for example, ITI-38, ITI-39, RAD-75)
Test Data
Consumers
The following test patients and their respective documents are maintained by the NIR team. They are intended for use when providing test evidence during onboarding, but you may also find them useful during your own development and testing.
Note: these test patient cases are available in both the Sandbox and INT environments.
| Test Patient NHS Numbers | Documents |
|---|---|
| 9694116422 |
Total: 1 Document 1 - PDF Document metadata: HomeCommunityId - urn:oid:1.2.34.567.8.1, RepositoryUniqueId - 1.1.4567332.1.7, DocumentUniqueId - 1.2.42.20251212161454.2, CreationTime: 20061224 |
| 9898841141 |
Total: 2 Document 1 - DICOM Document metadata: HomeCommunityId - urn:oid:1.2.34.567.8.1, RepositoryUniqueId - 1.1.4567332.1.7, DocumentUniqueId - 2.25.90214658647374166344513344800740950001, CreationTime: 20160922153918 Document 2 - PDF Document metadata: HomeCommunityId - urn:oid:1.2.34.567.8.1, RepositoryUniqueId - 1.1.4567332.1.7, DocumentUniqueId - 1.2.42.20260115152435.2, CreationTime: 20061224 |
| 9932549118 |
Total: 2 Document 1 - TXT Document metadata: HomeCommunityId - urn:oid:1.2.34.567.8.1, RepositoryUniqueId - 1.1.4567332.1.7, DocumentUniqueId - 1.2.42.20251212161454.4, CreationTime: 20041224 Document 2 - DICOM Document metadata: HomeCommunityId - urn:oid:1.2.34.567.8.2, RepositoryUniqueId - 1.1.4567332.1.2, DocumentUniqueId - 2.25.90214658647374166344513344800740950001, CreationTime: 20160922153918 |
Providers
You must create and share your test data - or at the very least the identifiers required to make the requests - with the NIR team during INT environment onboarding. The NIR team will then verify that the test cases can be executed successfully via the NIR API.
You must ensure that the test patient NHS numbers you create do not conflict with the NHS numbers above, as they are relied upon for consumer testing.
The test NHS numbers you create must be valid and should begin with the digit 9.
Last edited: 14 July 2026 3:34 pm