POST Api/Profiles/ExtractDataFromFile

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Files		Collection of UploadFile	None.

Request Formats

application/json, text/json

Sample:

{
  "files": [
    {
      "fileName": "sample string 1",
      "content": "sample string 2",
      "overwrite": true
    },
    {
      "fileName": "sample string 1",
      "content": "sample string 2",
      "overwrite": true
    }
  ]
}

multipart/form-data

Sample:

{"files":[{"fileName":"sample string 1","content":"sample string 2","overwrite":true},{"fileName":"sample string 1","content":"sample string 2","overwrite":true}]}

application/xml, text/xml

Sample:

<UploadFileList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Files>
    <UploadFile>
      <FileName>sample string 1</FileName>
      <Content>sample string 2</Content>
      <Overwrite>true</Overwrite>
    </UploadFile>
    <UploadFile>
      <FileName>sample string 1</FileName>
      <Content>sample string 2</Content>
      <Overwrite>true</Overwrite>
    </UploadFile>
  </Files>
</UploadFileList>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IdentityDocumentData

Name	Type	Additional information
TypeOfDocumentId	integer	None.
CountryId	integer	None.
Name	string	None.
Surname	string	None.
DocumentSeries	string	None.
DocumentNumber	string	None.
FullDocumentNumber	string	None.
Pesel	string	None.
ExportId	string	None.
NationalityId	integer	None.
DateOfBirth	date	None.
Gender	integer	None.
IsValid	boolean	None.
Documents	Collection of IdentityPageData	None.

Response Formats

application/json, text/json

Sample:

{
  "typeOfDocumentId": 1,
  "countryId": 1,
  "name": "sample string 1",
  "surname": "sample string 2",
  "documentSeries": "sample string 3",
  "documentNumber": "sample string 4",
  "fullDocumentNumber": "sample string 3sample string 4",
  "pesel": "sample string 5",
  "exportId": "sample string 6",
  "nationalityId": 1,
  "dateOfBirth": "2024-05-18T04:21:11.4480349+00:00",
  "gender": 1,
  "isValid": true,
  "documents": [
    {
      "pageType": 0,
      "files": [
        "sample string 1",
        "sample string 2"
      ],
      "typeOfSharedDocumentId": 1,
      "countryId": 1,
      "documentSeries": "sample string 1",
      "documentNumber": "sample string 2",
      "fullDocumentNumber": "sample string 1sample string 2",
      "startDate": "2024-05-18T04:21:11.4480349+00:00",
      "endDate": "2024-05-18T04:21:11.4480349+00:00"
    },
    {
      "pageType": 0,
      "files": [
        "sample string 1",
        "sample string 2"
      ],
      "typeOfSharedDocumentId": 1,
      "countryId": 1,
      "documentSeries": "sample string 1",
      "documentNumber": "sample string 2",
      "fullDocumentNumber": "sample string 1sample string 2",
      "startDate": "2024-05-18T04:21:11.4480349+00:00",
      "endDate": "2024-05-18T04:21:11.4480349+00:00"
    }
  ]
}

multipart/form-data

Sample:

{"typeOfDocumentId":1,"countryId":1,"name":"sample string 1","surname":"sample string 2","documentSeries":"sample string 3","documentNumber":"sample string 4","fullDocumentNumber":"sample string 3sample string 4","pesel":"sample string 5","exportId":"sample string 6","nationalityId":1,"dateOfBirth":"2024-05-18T04:21:11.4480349+00:00","gender":1,"isValid":true,"documents":[{"pageType":0,"files":["sample string 1","sample string 2"],"typeOfSharedDocumentId":1,"countryId":1,"documentSeries":"sample string 1","documentNumber":"sample string 2","fullDocumentNumber":"sample string 1sample string 2","startDate":"2024-05-18T04:21:11.4480349+00:00","endDate":"2024-05-18T04:21:11.4480349+00:00"},{"pageType":0,"files":["sample string 1","sample string 2"],"typeOfSharedDocumentId":1,"countryId":1,"documentSeries":"sample string 1","documentNumber":"sample string 2","fullDocumentNumber":"sample string 1sample string 2","startDate":"2024-05-18T04:21:11.4480349+00:00","endDate":"2024-05-18T04:21:11.4480349+00:00"}]}

application/xml, text/xml

Sample:

<IdentityDocumentData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TypeOfDocumentId>1</TypeOfDocumentId>
  <CountryId>1</CountryId>
  <Name>sample string 1</Name>
  <Surname>sample string 2</Surname>
  <DocumentSeries>sample string 3</DocumentSeries>
  <DocumentNumber>sample string 4</DocumentNumber>
  <Pesel>sample string 5</Pesel>
  <ExportId>sample string 6</ExportId>
  <NationalityId>1</NationalityId>
  <DateOfBirth>2024-05-18T04:21:11.4480349+00:00</DateOfBirth>
  <Gender>1</Gender>
  <IsValid>true</IsValid>
  <Documents>
    <IdentityPageData>
      <PageType>TravelDocumentTD1</PageType>
      <Files>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </Files>
      <TypeOfSharedDocumentId>1</TypeOfSharedDocumentId>
      <CountryId>1</CountryId>
      <DocumentSeries>sample string 1</DocumentSeries>
      <DocumentNumber>sample string 2</DocumentNumber>
      <StartDate>2024-05-18T04:21:11.4480349+00:00</StartDate>
      <EndDate>2024-05-18T04:21:11.4480349+00:00</EndDate>
    </IdentityPageData>
    <IdentityPageData>
      <PageType>TravelDocumentTD1</PageType>
      <Files>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </Files>
      <TypeOfSharedDocumentId>1</TypeOfSharedDocumentId>
      <CountryId>1</CountryId>
      <DocumentSeries>sample string 1</DocumentSeries>
      <DocumentNumber>sample string 2</DocumentNumber>
      <StartDate>2024-05-18T04:21:11.4480349+00:00</StartDate>
      <EndDate>2024-05-18T04:21:11.4480349+00:00</EndDate>
    </IdentityPageData>
  </Documents>
</IdentityDocumentData>