Guest  Login
Reader

WMTransfer Wiki
Interface X11

Interface X11. Retrieving information from client’s passport by WM-identifier.

<request>
	<wmid></wmid>
	<passportwmid></passportwmid>
	<sign></sign>
		<params>
			<dict></dict>
			<info></info>
			<mode></mode>
		</params>
</request>

You can see a working sample here (recalled personal passport)

  • Request parameters:
name purpose comments
wmid Signer’s WM-identifier. Only WM Keeper Classic 12 digits
passportwmid Passport’s WM-identifier( mandatory parameter ) 12 digits
sign Request signature generated with the help of the WMSigner module Request signature uses the following parameters: wmid+passportwmid
params request parameters
params/dict Show “base dictionary” According to the structure, some returned values are replaced with special code (for example, personal passport is replaced with value of ‘130’,etc). The dictionary allows viewing all the values and use them when working with this interface. If dict=“1” – then the dictionary is shown. If dict=“0”(by default) – the dictionary is not shown.
params/info Show personal data of passport's owner (passport data+contact information) If info=“1”(by default) – personal data is displayed. If info=“0” – personal data is not displayed.
params/mode Verifying ownership of Signer’s WM-identifier against the list of trusted identifiers for the verified passport Each passport owner can add any WM-identifier to the list of trusted identifiers. A trusted identifier gets a possibility to view all passport data even those locked for public viewing. If mode=“1” – ownership of Signer’s WM-identifier is verified against the list of trusted identifiers for the specified passport. If mode=“0”(by default)- ownership is not verified

The user can use authentication via WM Keeper Classic keys in request ONLY in case when Signer’s WMID is a trusted identifier for the specified passport. To establish trust relationship go to the Verification Center web-site. Trusted WMID can view all personal data about passport owner. Trusting is a voluntary operation made by passport owner, who can add WMIDs to the trusted list or remove them from the list by using a special interface.
If trust relationship was not established between the verified WMID and signer’s WMID, then it is possible to specify only the passportwmid parameter. The request structure (presence of all tags described earlier) must not change in any case. Samples of interface call for both cases are given below.

  • Full response format:
<?xml version="1.0" encoding="windows-1251"?>
<response retval="">
<fullaccess></fullaccess>
	<certinfo wmid="">
		<directory>
		</directory>
		<attestat>
			<row cid="" regcid="" tid="" locked="" admlocked="" recalled="" datecrt="" regnickname="" regwmid=""/>
		</attestat>
		<wmids>
			<row wmid="" info="" nickname="" datereg=""/>
		</wmids>
		<userinfo>
			<value>
				<row ctype="" jstatus=""  osnovainfo="" locked="" nickname="" infoopen="" city="" country="" zipcode="" adres="" fname="" iname="" oname="" pnomer="" pdate="" pcountry="" pcity="" pbywhom="" rcountry="" rcity="" radres="" bplace="" bday="" bmonth="" byear="" name="" dirfio="" buhfio=""
 inn="" okpo="" okonx="" jadres="" jcountry="" jcity="" jzipcode="" bankname="" bik="" ks="" rs="" phonehome="" phonemobile="" icq="" fax="" email="" web="" phone="" cap_owner="" pasdoc="" inndoc=""/>
			</value>
			<check-lock>
				<row jstatus="" osnovainfo="" nickname="" infoopen="" city="" country="" adres="" zipcode="" fname="" iname="" oname="" pnomer="" pdate="" pbywhom="" pcountry="" pcity="" rcountry="" rcity="" radres="" bplace="" bday="" name="" dirfio="" buhfio="" inn="" okpo="" okonx=""
 jadres="" jcountry="" jcity="" jzipcode="" bankname="" bik="" ks="" rs="" fax="" email="" web="" phone="" phonehome="" phonemobile="" icq=""/>
			</check-lock>
		</userinfo>
	</certinfo>
</response>
  • Response parameters:
name purpose comments
response/@retval Request execution code retval=0 – Request successful without any errors
retval=1 – Request failed (wrong request format)
retval=2 – Request failed (wrong passportwmid parameter)
retval=4 – Request failed (Error when verifying signature)
retval=11 – Request failed (one of parameters is not specified)
fullaccess Indicator of access to passport’s restricted fields If fullaccess=1, the owner of the verified WMID added Signer’s WMID to the trusted list and granted full access to his/her personal data. If fullaccess=0, there is no access to the restricted passport fields of the verified WMID.
response/certinfo information about passport
response/certinfo/@wmid Passport WM-identifier
response/certinfo/directory Base dictionary ctype – legal status of passport owner (individual person or legal person)
jstatus – status definition for legal person (Director, representative, etc)
tid – passport type
response/certinfo/attestat/row _ Information about all issued passports. There can be several <row /> tags (according to the number of passports). In this case the first block will contain the information about the current passport type. For example, if for the given WMID Initial and Personal passports were issued at various times, then the first tag will be <row tid="130">
response/certinfo/attestat/row/@cid Internal number of passport owner in the Verification Center system (unique)
response/certinfo/attestat/row/@regcid Internal number of passport issuer in the Verification Center system (unique)
response/certinfo/attestat/row/@tid Passport type See “base dictionary”
When analyzing the given parameter it is necessary to pay attention to the following attribute: response/certinfo/attestat/row/recalled or: response/certinfo/userinfo/value/row/locked
If its value is 1, then this passport was recalled and its status equals to Alias passport.

You can check any of the attributes.
response/certinfo/attestat/row/@locked Right to issue passports If owners of Personal passports have locked=0 it means they have the right to issue Initial passports, if owners of Registrar passports have locked=0 it means they have the right to issue Personal passports. locked=1 means Passport issueing is temporarily blocked or absence of such right.
response/certinfo/attestat/row/@admlocked Right to issue passports If owners of Personal passports have admlocked=0, it means that they have the right to issue Initial passports, if owners of Registrar passports have admlocked=0, it means they have the right to issue Personal passports. admlocked=1 means this passport issuer was deprived of the right to issue passports.
response/certinfo/attestat/row/@recalled Information about passport recall If the attribute is set to 1, then this passport was recalled and its status is equal to Alias passport.
This parameter is equal to response/certinfo/userinfo/value/row/@locked
response/certinfo/attestat/row/@datecrt Date and time (Moscow time) when passport was issued
response/certinfo/attestat/row/@datediff Difference in days between the current date and passport issue date
response/certinfo/attestat/row/@regnickname Project name, name (nick) of passport issuer who issued this passport
response/certinfo/attestat/row/@regwmid WMID of passport issuer who issued this passport 12 digits
response/certinfo/wmids/row _ Information about all WMIDs attached to this passport. The owners of passports having more than one WMID can set unique characteristics for each of them (additional information and name (nick))
response/certinfo/wmids/row/@wmid WMID 12 digits
response/certinfo/wmids/row/@info Additional information about WMID.
response/certinfo/wmids/row/@nickname Unique name (nick) for this WMID
response/certinfo/wmids/row/@datereg Date and time (Moscow time) when WMID was registered in the system In the following format YYYY-MM-DDTHH:MM:SS.SSS
response/certinfo/wmids/row/@yearreg WMID registration year in the system In YYYY format
response/certinfo/wmids/row/@monthreg WMID registration month in the system From “1” to “12”
response/certinfo/wmids/row/@dayreg WMID registration day in the system From “1” to “31”
response/certinfo/wmids/row/@timereg WMID registration time (Moscow) in the system In HH:MM:SS format
response/certinfo/userinfo _ Personal data about passport owner, verification of the data by the passport issuer or viewing of personal data being disabled
response/certinfo/userinfo/value/row _ Personal data about passport owner.
response/certinfo/userinfo/value/row/@ctype Owner status See “base dictionary”.
ctype =“1” – Individual person
ctype =“2” – Legal person
response/certinfo/userinfo/value/row/@jstatus For legal person. Status (Director, representative, etc.) See base dictionary.
response/certinfo/userinfo/value/row/@osnovainfo For legal person. The basis he/she acts upon (regulations, power of attorney, etc.)
response/certinfo/userinfo/value/row/@locked Information about passport recall If this attribute equals 1, then this passport was recalled and its status is equal to Alias passport.
This parameter is equal to response/certinfo/attestat/row/@recalled
response/certinfo/userinfo/value/row/@nickname Project name, name (nick)
response/certinfo/userinfo/value/row/@infoopen Additional information (direction of activities, comments, commercial information
response/certinfo/userinfo/value/row/@city Actual location (city) of the organization or WMID owner
response/certinfo/userinfo/value/row/@country Actual location (country) of the organization or WMID owner
response/certinfo/userinfo/value/row/@zipcode Actual location (postal code) of the organization or WMID owner
response/certinfo/userinfo/value/row/@adres Actual location (address) of the organization or WMID owner
response/certinfo/userinfo/value/row/@fname Surname of WMID owner
response/certinfo/userinfo/value/row/@iname Name of WMID owner
response/certinfo/userinfo/value/row/@oname Second (Patronymic) name of WMID owner
response/certinfo/userinfo/value/row/@pnomer Passport number of WMID owner
response/certinfo/userinfo/value/row/@pdate Passport issue date MM/DD/YYYY
response/certinfo/userinfo/value/row/@pcountry Passport issue place (country)
response/certinfo/userinfo/value/row/@pcity Passport issue place (city)
response/certinfo/userinfo/value/row/@pbywhom Passport issue place (by whom)
response/certinfo/userinfo/value/row/@rcountry Place (country) of permanent residence
response/certinfo/userinfo/value/row/@rcity Place (city) of permanent residence
response/certinfo/userinfo/value/row/@radres Place (full address) of permanent residence
response/certinfo/userinfo/value/row/@bplace Place of birth (city, country)
response/certinfo/userinfo/value/row/@bday Date of birth (day)
response/certinfo/userinfo/value/row/@bmonth Date of birth (month)
response/certinfo/userinfo/value/row/@byear Year of birth (year)
response/certinfo/userinfo/value/row/@name For legal person. Organization name
response/certinfo/userinfo/value/row/@dirfio For legal person. Director (Name, surname)
response/certinfo/userinfo/value/row/@buhfio For legal person. Chief accountant (Name, surname)
response/certinfo/userinfo/value/row/@inn For legal person. INN (taxpayer number)
response/certinfo/userinfo/value/row/@okpo For legal person. OKPO (Russian classifier of companies and organizations)
response/certinfo/userinfo/value/row/@okonx For legal person. OKVED (Russian classifier of types of economic activities)
response/certinfo/userinfo/value/row/@jadres For legal person. Legal address
response/certinfo/userinfo/value/row/@jcountry For legal person. Legal address (country)
response/certinfo/userinfo/value/row/@jcity For legal person. Legal address (city)
response/certinfo/userinfo/value/row/@jzipcode For legal person. Legal address (postal code)
response/certinfo/userinfo/value/row/@bankname For legal person. Bank details. Bank name.
response/certinfo/userinfo/value/row/@bik For legal person. Bank details. BIC.
response/certinfo/userinfo/value/row/@ks For legal person. Bank details. Correspondent account number.
response/certinfo/userinfo/value/row/@rs For legal person. Bank details. Current account number.
response/certinfo/userinfo/value/row/@phonehome Contact information of certified WMID owner. Home phone number.
response/certinfo/userinfo/value/row/@phonemobile Contact information of certified WMID owner. Mobile phone number.
response/certinfo/userinfo/value/row/@icq Contact information of certified WMID owner. UIN ICQ.
response/certinfo/userinfo/value/row/@fax Contact information of certified WMID owner. Fax number.
response/certinfo/userinfo/value/row/@email Contact information of certified WMID owner. E-mail address.
response/certinfo/userinfo/value/row/@web Contact information of certified WMID owner. Web-site address.
response/certinfo/userinfo/value/row/@phone Contact information of certified WMID owner. Contact phone number.
response/certinfo/userinfo/value/row/@cap_owner Only for Capitaller passports. Founder’s WMID. 12 digits
response/certinfo/userinfo/value/row/@pasdoc Verification of passport’s e-copy by Verification Center admin. If pasdoc = 1, then electronic copy was verified by Verification Center admin. If pasdoc = 0, then electronic copy was not verified by Verification Center admin.
response/certinfo/userinfo/value/row/@inndoc Verification of e-copy of the INN certificate by Verification Center admin. If inndoc = 1, then electronic copy was verified by Verification Center admin. If inndoc = 0, then electronic copy was not verified by Verification Center admin.
response/certinfo/userinfo/check-lock/row _ Verification of personal data by passport issuer and blocking of public viewing of personal data. These attributes have tags similar to the tags described in the response/certinfo/userinfo/value/row block.
The attributes can have the following values:
00 – this field was not verified by passport issuer and was not restricted by passport owner from public viewing
01 – this field was not verified by passport issuer and was restricted by passport owner from public viewing
10 – this field was verified by passport issuer and was not restricted by passport owner from public viewing
11 – this field was verified by passport issuer and was restricted by passport owner from public viewing
For example:If @fname=“10”, then surname of passport owner was verified by passport issuer. This field is available for public viewing.

See also XML-interfaces

Category: XML-Interfaces

This article in other languages: Русский