POST web_api/gscanitems_v5_9

Send a new request to the gScan OCR service for processing.

Request Information

URI Parameters

None.

Body Parameters

The new request to be processed should be included in the body formatted as an GScanRequest_5_9 object.

GScanRequest_5_9
NameDescriptionTypeAdditional information
CheckImageFront

Front of the check for OCR processing

 Collection of byte

None.
CheckImageBack

Back of the check for OCR processing

 Collection of byte

None.
PhotoIDImageFront

Front of the Photo ID for OCR processing

 Collection of byte

None.
PhotoIDImageBack

Back of the Photo ID for Bar-Code processing

 Collection of byte

None.
RestrictiveEndorsementPhrases

Restrictive Endorsement Phrases

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "CheckImageFront": "QEA=",
  "CheckImageBack": "QEA=",
  "PhotoIDImageFront": "QEA=",
  "PhotoIDImageBack": "QEA=",
  "RestrictiveEndorsementPhrases": "sample string 1"
}

application/xml, text/xml

Sample: 
<GScanRequest_5_9 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.giact.com/verificationservices/v5_9/services">
  <CheckImageBack>QEA=</CheckImageBack>
  <CheckImageFront>QEA=</CheckImageFront>
  <PhotoIDImageBack>QEA=</PhotoIDImageBack>
  <PhotoIDImageFront>QEA=</PhotoIDImageFront>
  <RestrictiveEndorsementPhrases>sample string 1</RestrictiveEndorsementPhrases>
</GScanRequest_5_9>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The result of the request will be in the body formatted as an GScanResult_5_9 object. We highly recommend that you store the result's GScanItemId value in your system so that you will be able to refer this unique request/result pair.

GScanResult_5_9
NameDescriptionTypeAdditional information
ErrorMessage

If there are any errors processing the request, then the ErrorMessage will have details on the error

 string

None.
GScanItemID

The gScan Item ID used to reference this result

 integer

None.
CheckData

Result of Check OCR processing

 GScanCheckData

None.
PhotoIDData

Result of Photo ID OCR/Bar-Code processing

 GScanPhotoIdData

None.
AdvancedData

Advanced data from the OCR process

 GScanAdvancedData

None.

Response Formats

application/json, text/json

Sample: 
{
  "ErrorMessage": "sample string 1",
  "GScanItemID": 2,
  "CheckData": {
    "CheckInfo": {
      "RoutingNumber": "sample string 1",
      "AccountNumber": "sample string 2",
      "CheckNumber": "sample string 3",
      "CheckAmount": 1.0,
      "AccountType": 0
    },
    "IssuerDate": "2025-04-28T06:46:35.6831252-05:00",
    "IssuerName": "sample string 1",
    "PayableToNames": [
      "sample string 1",
      "sample string 2"
    ],
    "EndorsementMissing": true,
    "SignatureMissing": true,
    "IsPrinted": true,
    "PayableToMultiplePeople": true,
    "ProcessedFront": "QEA=",
    "ProcessedBack": "QEA="
  },
  "PhotoIDData": {
    "CustomerInfo": {
      "EntityType": 0,
      "NamePrefix": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "NameSuffix": "sample string 5",
      "BusinessName": "sample string 6",
      "AddressLine1": "sample string 7",
      "AddressLine2": "sample string 8",
      "City": "sample string 9",
      "State": "sample string 10",
      "ZipCode": "sample string 11",
      "Country": "sample string 12",
      "PhoneNumber": "sample string 13",
      "TaxId": "sample string 14",
      "DateOfBirth": "2025-04-28T06:46:35.6831252-05:00",
      "DlNumber": "sample string 15",
      "DlState": "sample string 16",
      "EmailAddress": "sample string 17",
      "CurrentIpAddress": "sample string 18",
      "Domain": "sample string 19",
      "MobileConsentRecordId": 1,
      "AltIdType": 0,
      "AltIdIssuer": "sample string 20",
      "AltIdNumber": "sample string 21"
    },
    "IssueDate": "2025-04-28T06:46:35.6831252-05:00",
    "ExpirationDate": "2025-04-28T06:46:35.6831252-05:00",
    "Gender": "sample string 1",
    "Height": "sample string 2",
    "Weight": "sample string 3",
    "Eyes": "sample string 4",
    "Hair": "sample string 5"
  },
  "AdvancedData": {
    "ErrorMessages": [
      "sample string 1",
      "sample string 2"
    ],
    "FullMicrLine": "sample string 1",
    "RTN": "sample string 2",
    "OnUs": "sample string 3",
    "AuxOnUs": "sample string 4",
    "OcrConfidenceScore_MicrLine": 5,
    "OcrConfidenceScore_CheckNumber": 6,
    "OcrConfidenceScore_Amount": 7,
    "OcrConfidenceScore_IssuerDate": 8,
    "OcrConfidenceScore_IssuerName": 9,
    "OcrConfidenceScore_PayableToName": 10,
    "OcrConfidenceScore_SignatureMissing": 11,
    "OcrConfidenceScore_EndorsementPresent": 12,
    "OcrWriteType_CourtesyAmount": "sample string 13",
    "OcrWriteType_LegalAmount": "sample string 14",
    "CheckType": "sample string 15",
    "RestrictiveEndorsement": true,
    "OcrConfidenceScore_RestrictiveEndorsement": 17,
    "OcrConfidenceScore_MobileDepositChecked": 18,
    "MitekTransactionId": 1
  }
}

application/xml, text/xml

Sample: 
<GScanResult_5_9 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.giact.com/verificationservices/v5">
  <AdvancedData>
    <AuxOnUs>sample string 4</AuxOnUs>
    <CheckType>sample string 15</CheckType>
    <ErrorMessages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ErrorMessages>
    <FullMicrLine>sample string 1</FullMicrLine>
    <MitekTransactionId>1</MitekTransactionId>
    <OcrConfidenceScore_Amount>7</OcrConfidenceScore_Amount>
    <OcrConfidenceScore_CheckNumber>6</OcrConfidenceScore_CheckNumber>
    <OcrConfidenceScore_EndorsementPresent>12</OcrConfidenceScore_EndorsementPresent>
    <OcrConfidenceScore_IssuerDate>8</OcrConfidenceScore_IssuerDate>
    <OcrConfidenceScore_IssuerName>9</OcrConfidenceScore_IssuerName>
    <OcrConfidenceScore_MicrLine>5</OcrConfidenceScore_MicrLine>
    <OcrConfidenceScore_MobileDepositChecked>18</OcrConfidenceScore_MobileDepositChecked>
    <OcrConfidenceScore_PayableToName>10</OcrConfidenceScore_PayableToName>
    <OcrConfidenceScore_RestrictiveEndorsement>17</OcrConfidenceScore_RestrictiveEndorsement>
    <OcrConfidenceScore_SignatureMissing>11</OcrConfidenceScore_SignatureMissing>
    <OcrWriteType_CourtesyAmount>sample string 13</OcrWriteType_CourtesyAmount>
    <OcrWriteType_LegalAmount>sample string 14</OcrWriteType_LegalAmount>
    <OnUs>sample string 3</OnUs>
    <RTN>sample string 2</RTN>
    <RestrictiveEndorsement>true</RestrictiveEndorsement>
  </AdvancedData>
  <CheckData xmlns:d2p1="http://schemas.datacontract.org/2004/07/VerificationServicesApi.CustomClasses">
    <d2p1:CheckInfo>
      <AccountNumber>sample string 2</AccountNumber>
      <AccountType>Checking</AccountType>
      <CheckAmount>1</CheckAmount>
      <CheckNumber>sample string 3</CheckNumber>
      <RoutingNumber>sample string 1</RoutingNumber>
    </d2p1:CheckInfo>
    <d2p1:EndorsementMissing>true</d2p1:EndorsementMissing>
    <d2p1:IsPrinted>true</d2p1:IsPrinted>
    <d2p1:IssuerDate>2025-04-28T06:46:35.6831252-05:00</d2p1:IssuerDate>
    <d2p1:IssuerName>sample string 1</d2p1:IssuerName>
    <d2p1:PayableToMultiplePeople>true</d2p1:PayableToMultiplePeople>
    <d2p1:PayableToNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:PayableToNames>
    <d2p1:ProcessedBack>QEA=</d2p1:ProcessedBack>
    <d2p1:ProcessedFront>QEA=</d2p1:ProcessedFront>
    <d2p1:SignatureMissing>true</d2p1:SignatureMissing>
  </CheckData>
  <ErrorMessage>sample string 1</ErrorMessage>
  <GScanItemID>2</GScanItemID>
  <PhotoIDData xmlns:d2p1="http://schemas.datacontract.org/2004/07/VerificationServicesApi.CustomClasses">
    <d2p1:CustomerInfo>
      <AddressLine1>sample string 7</AddressLine1>
      <AddressLine2>sample string 8</AddressLine2>
      <AltIdIssuer>sample string 20</AltIdIssuer>
      <AltIdNumber>sample string 21</AltIdNumber>
      <AltIdType>UsaMilitaryId</AltIdType>
      <BusinessName>sample string 6</BusinessName>
      <City>sample string 9</City>
      <Country>sample string 12</Country>
      <CurrentIpAddress>sample string 18</CurrentIpAddress>
      <DateOfBirth>2025-04-28T06:46:35.6831252-05:00</DateOfBirth>
      <DlNumber>sample string 15</DlNumber>
      <DlState>sample string 16</DlState>
      <Domain>sample string 19</Domain>
      <EmailAddress>sample string 17</EmailAddress>
      <EntityType>UnknownNotApplicable</EntityType>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 4</LastName>
      <MiddleName>sample string 3</MiddleName>
      <MobileConsentRecordId>1</MobileConsentRecordId>
      <NamePrefix>sample string 1</NamePrefix>
      <NameSuffix>sample string 5</NameSuffix>
      <PhoneNumber>sample string 13</PhoneNumber>
      <State>sample string 10</State>
      <TaxId>sample string 14</TaxId>
      <ZipCode>sample string 11</ZipCode>
    </d2p1:CustomerInfo>
    <d2p1:ExpirationDate>2025-04-28T06:46:35.6831252-05:00</d2p1:ExpirationDate>
    <d2p1:Eyes>sample string 4</d2p1:Eyes>
    <d2p1:Gender>sample string 1</d2p1:Gender>
    <d2p1:Hair>sample string 5</d2p1:Hair>
    <d2p1:Height>sample string 2</d2p1:Height>
    <d2p1:IssueDate>2025-04-28T06:46:35.6831252-05:00</d2p1:IssueDate>
    <d2p1:Weight>sample string 3</d2p1:Weight>
  </PhotoIDData>
</GScanResult_5_9>