POST api/OCR/FetchOCRData

Request Information

URI Parameters

None.

Body Parameters

ImageDatarequestOCR
NameDescriptionTypeAdditional information
FrontImage

string

None.

BackImage

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FrontImage": "sample string 1",
  "BackImage": "sample string 2"
}

application/xml, text/xml

Sample:
<NoqoodyUserModels.ImageDatarequestOCR xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
  <BackImage>sample string 2</BackImage>
  <FrontImage>sample string 1</FrontImage>
</NoqoodyUserModels.ImageDatarequestOCR>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OCRModelResponse_QID
NameDescriptionTypeAdditional information
IDNo

string

None.

Name

string

None.

arabicName

string

None.

dob

date

None.

Expiry

date

None.

PassportExpiry

date

None.

occupationArabic

string

None.

Nationality

string

None.

PassportNumber

string

None.

residencyType

string

None.

Employer

string

None.

success

boolean

None.

code

string

None.

message

string

None.

errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "IDNo": "sample string 1",
  "Name": "sample string 2",
  "arabicName": "sample string 3",
  "dob": "15/06/2025",
  "Expiry": "15/06/2025",
  "PassportExpiry": "15/06/2025",
  "occupationArabic": "sample string 7",
  "Nationality": "sample string 8",
  "PassportNumber": "sample string 9",
  "residencyType": "sample string 10",
  "Employer": "sample string 11",
  "success": true,
  "code": "sample string 13",
  "message": "sample string 14",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<OCRModelResponse_QID xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models.GoogleAPI">
  <code xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">sample string 13</code>
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <message xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">sample string 14</message>
  <success xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">true</success>
  <Employer>sample string 11</Employer>
  <Expiry>2025-06-15T06:21:47.0133761+03:00</Expiry>
  <IDNo>sample string 1</IDNo>
  <Name>sample string 2</Name>
  <Nationality>sample string 8</Nationality>
  <PassportExpiry>2025-06-15T06:21:47.0133761+03:00</PassportExpiry>
  <PassportNumber>sample string 9</PassportNumber>
  <arabicName>sample string 3</arabicName>
  <dob>2025-06-15T06:21:47.0133761+03:00</dob>
  <occupationArabic>sample string 7</occupationArabic>
  <residencyType>sample string 10</residencyType>
</OCRModelResponse_QID>