GET api/BatchStatus/{id}

Get status of an existing batch request.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Batch ID	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

HTTP Status: 200 - OK - Batch - Batch Available. If Batch is Complete - will include BatchResults 401 - Unauthorized - User not authorized 404 - NotFound - Batch Not Available

Batch

Name	Description	Type	Additional information
Id	Batch Id	globally unique identifier	None.
Status	Batch Status	string	None.
Message	Batch Message / Information	string	None.
Results	Results if the Batch is complete	Collection of BatchResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "54fb677b-14df-489a-95b2-d5f3a4fbd0c8",
  "Status": "sample string 2",
  "Message": "sample string 3",
  "Results": [
    {
      "Decision": "sample string 1",
      "ExpirationDate": "12/6/2025",
      "NGB": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "MiddleName": "sample string 6",
      "EmailAddress": "sample string 7",
      "DateOfBirth": "12/6/2025",
      "UniqueId": "sample string 10",
      "FileNumber": 0,
      "Reference1": "sample string 11",
      "Reference2": "sample string 12",
      "Reference3": "sample string 13"
    },
    {
      "Decision": "sample string 1",
      "ExpirationDate": "12/6/2025",
      "NGB": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "MiddleName": "sample string 6",
      "EmailAddress": "sample string 7",
      "DateOfBirth": "12/6/2025",
      "UniqueId": "sample string 10",
      "FileNumber": 0,
      "Reference1": "sample string 11",
      "Reference2": "sample string 12",
      "Reference3": "sample string 13"
    }
  ]
}

application/xml, text/xml

Sample:

<Batch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NCSI.API.ViewModels">
  <Id>54fb677b-14df-489a-95b2-d5f3a4fbd0c8</Id>
  <Message>sample string 3</Message>
  <Results>
    <BatchResult>
      <DateOfBirth>12/6/2025</DateOfBirth>
      <DateOfBirthDt>2025-12-06T00:19:56.7884071-05:00</DateOfBirthDt>
      <EmailAddress>sample string 7</EmailAddress>
      <FileNumber xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Numerics">
        <d4p1:_bits xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d4p1:_sign>0</d4p1:_sign>
      </FileNumber>
      <FirstName>sample string 4</FirstName>
      <LastName>sample string 5</LastName>
      <MiddleName>sample string 6</MiddleName>
      <NGB>sample string 3</NGB>
      <Reference1>sample string 11</Reference1>
      <Reference2>sample string 12</Reference2>
      <Reference3>sample string 13</Reference3>
      <UniqueId>sample string 10</UniqueId>
      <Decision>sample string 1</Decision>
      <ExpirationDt>2025-12-06T00:19:56.7884071-05:00</ExpirationDt>
    </BatchResult>
    <BatchResult>
      <DateOfBirth>12/6/2025</DateOfBirth>
      <DateOfBirthDt>2025-12-06T00:19:56.7884071-05:00</DateOfBirthDt>
      <EmailAddress>sample string 7</EmailAddress>
      <FileNumber xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Numerics">
        <d4p1:_bits xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d4p1:_sign>0</d4p1:_sign>
      </FileNumber>
      <FirstName>sample string 4</FirstName>
      <LastName>sample string 5</LastName>
      <MiddleName>sample string 6</MiddleName>
      <NGB>sample string 3</NGB>
      <Reference1>sample string 11</Reference1>
      <Reference2>sample string 12</Reference2>
      <Reference3>sample string 13</Reference3>
      <UniqueId>sample string 10</UniqueId>
      <Decision>sample string 1</Decision>
      <ExpirationDt>2025-12-06T00:19:56.7884071-05:00</ExpirationDt>
    </BatchResult>
  </Results>
  <Status>sample string 2</Status>
</Batch>

multipart/form-data

Sample:

<Batch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NCSI.API.ViewModels"><Id>54fb677b-14df-489a-95b2-d5f3a4fbd0c8</Id><Message>sample string 3</Message><Results><BatchResult><DateOfBirth>12/6/2025</DateOfBirth><DateOfBirthDt>2025-12-06T00:19:56.7884071-05:00</DateOfBirthDt><EmailAddress>sample string 7</EmailAddress><FileNumber xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Numerics"><d4p1:_bits xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /><d4p1:_sign>0</d4p1:_sign></FileNumber><FirstName>sample string 4</FirstName><LastName>sample string 5</LastName><MiddleName>sample string 6</MiddleName><NGB>sample string 3</NGB><Reference1>sample string 11</Reference1><Reference2>sample string 12</Reference2><Reference3>sample string 13</Reference3><UniqueId>sample string 10</UniqueId><Decision>sample string 1</Decision><ExpirationDt>2025-12-06T00:19:56.7884071-05:00</ExpirationDt></BatchResult><BatchResult><DateOfBirth>12/6/2025</DateOfBirth><DateOfBirthDt>2025-12-06T00:19:56.7884071-05:00</DateOfBirthDt><EmailAddress>sample string 7</EmailAddress><FileNumber xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Numerics"><d4p1:_bits xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /><d4p1:_sign>0</d4p1:_sign></FileNumber><FirstName>sample string 4</FirstName><LastName>sample string 5</LastName><MiddleName>sample string 6</MiddleName><NGB>sample string 3</NGB><Reference1>sample string 11</Reference1><Reference2>sample string 12</Reference2><Reference3>sample string 13</Reference3><UniqueId>sample string 10</UniqueId><Decision>sample string 1</Decision><ExpirationDt>2025-12-06T00:19:56.7884071-05:00</ExpirationDt></BatchResult></Results><Status>sample string 2</Status></Batch>