POST visitor/getByDoc?Token={Token}

Retrieve personal data for visitor by using document number, type, name and date of the birth. Agenda "Visits" has to be licensed. Privilege "View" of licensed agenda "Visitor - Persons" required. Data may also be restricted by record permission "View" of agenda "Visitor - Persons".

Request Information

Authorization

Authorization by token required

Availability

Method disabled by configuration

URI Parameters

Name	Description	Type	Additional information
Token	The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds	globally unique identifier	Required

Body Parameters

VisitGetByDocReq

Name	Description	Type	Additional information
DocNumber	Document number	string	Required String length: inclusive between 0 and 50
State	Issuing state	string	Required
DocType	Document type. The values meaning: Passport = 0, Identity card = 1, Another type = 2	integer	Required Matching regular expression pattern: [0,1,2]
Name	Visitor name	string	Required
Surname	Visitor Surname	string	Required
DateOfBirth	Date of the birth	date	None.

Request Formats

application/json, text/json

Sample:

{
  "DocNumber": "sample string 1",
  "State": "sample string 2",
  "DocType": 3,
  "Name": "sample string 4",
  "Surname": "sample string 5",
  "DateOfBirth": "2025-10-28T16:08:15.0767331+01:00"
}

application/xml, text/xml

Sample:

<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DocNumber>sample string 1</DocNumber>
  <State>sample string 2</State>
  <DocType>3</DocType>
  <Name>sample string 4</Name>
  <Surname>sample string 5</Surname>
  <DateOfBirth>2025-10-28T16:08:15.0767331+01:00</DateOfBirth>
</Request>

Response Information

Response Codes

Http Code	Error Number	Description
200 request succesfully done	0	Successfully done
400 bad request	1002	Entry parameter missing or parameter bindigs failed
401 unauthorized	1000	Token {0} not found
401 unauthorized	1001	Token {0} already expired
401 unauthorized	1006	Ip filter violated for ip client address [{0}]
401 unauthorized	1007	Ip filter [{0}] parsing failed
401 unauthorized	1008	Request rate policy violated for [{0}]
403 server refuses fo fulfill the request	1526	Privilege View of agenda Visitors violated for [Visitor {0}]
403 server refuses fo fulfill the request	1538	Record permission View of agenda Visitors violated for [{0}]
403 server refuses fo fulfill the request	1531	Searching by document failed
403 server refuses fo fulfill the request	8	Not licensed
404 required resource does not exist on the server	1527	No visitor found
415 unsupported Media Type		The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported
500 internal error		Server exception description

Resource Description

VisitorGetResp

Name	Description	Type	Additional information
Visitor	Visitor data	Visitor	None.

Response Formats

application/json

Sample:

{"Visitor":{"VisitorId":"e8590d75-ae58-405c-87c3-abd03092c22e","Name":"Ian","Surname":"Apple","Firm":"The Big Company ltd.","Document":null,"FingerPrintISO":null,"FingerPrintSuprema":null,"Activities":[{"ActivityType":{"Title":"Activity A","Shortcut":"AA","Frequency":0,"Signed":0},"ValidTo":"\/Date(1761692400000)\/","Description":"Some description of this activity","Attachment":null},{"ActivityType":{"Title":"Activity B","Shortcut":"BB","Frequency":0,"Signed":0},"ValidTo":"\/Date(1762038000000)\/","Description":"Some description of this activity","Attachment":null}]}}

application/xml

Sample:


<Response>
  <Visitor>
    <VisitorId>e8590d75-ae58-405c-87c3-abd03092c22e</VisitorId>
    <Name>Ian</Name>
    <Surname>Apple</Surname>
    <Firm>The Big Company ltd.</Firm>
    <Activities>
      <VisitorActivity>
        <ActivityType>
          <Title>Activity A</Title>
          <Shortcut>AA</Shortcut>
          <Frequency>0</Frequency>
          <Signed>0</Signed>
        </ActivityType>
        <ValidTo>2025-10-29T00:00:00+01:00</ValidTo>
        <Description>Some description of this activity</Description>
      </VisitorActivity>
      <VisitorActivity>
        <ActivityType>
          <Title>Activity B</Title>
          <Shortcut>BB</Shortcut>
          <Frequency>0</Frequency>
          <Signed>0</Signed>
        </ActivityType>
        <ValidTo>2025-11-02T00:00:00+01:00</ValidTo>
        <Description>Some description of this activity</Description>
      </VisitorActivity>
    </Activities>
  </Visitor>
</Response>

text/json

Sample:

{
  "Visitor": {
    "VisitorId": "8f0d17c7-ba3b-4dc5-afca-0d69f6b5caa6",
    "Name": "sample string 1",
    "Surname": "sample string 2",
    "Firm": "sample string 3",
    "Document": {
      "Nationality": "sample string 1",
      "Sex": 2,
      "Name": "sample string 1",
      "Surname": "sample string 2",
      "DocNumber": "sample string 3",
      "DocType": 4,
      "DateOfBirth": "2025-10-28T16:08:15.0922004+01:00",
      "DateExpiration": "2025-10-28T16:08:15.0922004+01:00",
      "State": "sample string 5"
    },
    "FingerPrintISO": "sample string 4",
    "FingerPrintSuprema": "sample string 5",
    "Activities": [
      {
        "ActivityType": {
          "Title": "sample string 1",
          "Shortcut": "sample string 2",
          "Frequency": 3,
          "Signed": 4
        },
        "ValidTo": "2025-10-28T16:08:15.0922004+01:00",
        "Description": "sample string 1",
        "Attachment": {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Path": "sample string 3",
          "Data": "QEA="
        }
      },
      {
        "ActivityType": {
          "Title": "sample string 1",
          "Shortcut": "sample string 2",
          "Frequency": 3,
          "Signed": 4
        },
        "ValidTo": "2025-10-28T16:08:15.0922004+01:00",
        "Description": "sample string 1",
        "Attachment": {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Path": "sample string 3",
          "Data": "QEA="
        }
      }
    ]
  }
}

text/xml

Sample:

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Visitor>
    <VisitorId>8f0d17c7-ba3b-4dc5-afca-0d69f6b5caa6</VisitorId>
    <Name>sample string 1</Name>
    <Surname>sample string 2</Surname>
    <Firm>sample string 3</Firm>
    <Document>
      <Nationality>sample string 1</Nationality>
      <Sex>2</Sex>
      <Name>sample string 1</Name>
      <Surname>sample string 2</Surname>
      <DocNumber>sample string 3</DocNumber>
      <DocType>4</DocType>
      <DateOfBirth>2025-10-28T16:08:15.0922004+01:00</DateOfBirth>
      <DateExpiration>2025-10-28T16:08:15.0922004+01:00</DateExpiration>
      <State>sample string 5</State>
    </Document>
    <FingerPrintISO>sample string 4</FingerPrintISO>
    <FingerPrintSuprema>sample string 5</FingerPrintSuprema>
    <Activities>
      <VisitorActivity>
        <ActivityType>
          <Title>sample string 1</Title>
          <Shortcut>sample string 2</Shortcut>
          <Frequency>3</Frequency>
          <Signed>4</Signed>
        </ActivityType>
        <ValidTo>2025-10-28T16:08:15.0922004+01:00</ValidTo>
        <Description>sample string 1</Description>
        <Attachment>
          <Name>sample string 1</Name>
          <Description>sample string 2</Description>
          <Path>sample string 3</Path>
          <Data>QEA=</Data>
        </Attachment>
      </VisitorActivity>
      <VisitorActivity>
        <ActivityType>
          <Title>sample string 1</Title>
          <Shortcut>sample string 2</Shortcut>
          <Frequency>3</Frequency>
          <Signed>4</Signed>
        </ActivityType>
        <ValidTo>2025-10-28T16:08:15.0922004+01:00</ValidTo>
        <Description>sample string 1</Description>
        <Attachment>
          <Name>sample string 1</Name>
          <Description>sample string 2</Description>
          <Path>sample string 3</Path>
          <Data>QEA=</Data>
        </Attachment>
      </VisitorActivity>
    </Activities>
  </Visitor>
</Response>