User Tools

Site Tools


uwcfsdocumentloader

This is an old revision of the document!


UWCFSDocumentLoader

API specification for upload MoneyPolo client documents.



Service address

Security

Every transmitted request must be signed by the secret key. Issuance of the key by the company MayzusFS to the Client is performed at the beginning of testing. The key is changed at the transfer to the production version of the service.



UWCFSSaveClientDocument

Request parameters:
Name Type Description
PersonRUID UInt32 RUID of the client (Remote User ID - unique identificator on the merchant side)
FileContent string File content in Base64 encoding. Max length for parameter is - 7 000 000
FileType string File type, see Handbook 1
DocumentType string Document type, see Handbook 2
FieldValues string Document field values
MRZ string document MRZ string

FieldValues - Filled document fields are concatenated into a string in the following format: (<field name> = <value of the field>;){n} where n - number of required fields for a particular type of document. A list of fields for each type of document see in the Handbook 3

Signature
Name Type Description
MerchantCode string Merchants's code
Sign string Signature

Rules for compiling signatures to a Web service request. Each method has an object sign:

<sign>
	<MerchantCode>string</MerchantCode> 
	<Sign>string</Sign>
</sign>

For the correct signature generation (Sign) the following is needed:

  • produce a concatenation of data, transferred to the method of service in request object, and Key.
  • apply to the result algorythm SHA512.
  • convert the result to the upper case.

Data concatenation order in the method:

PersonRUID + FileContent + FileType + DocumentType  + FieldValues + MRZ + Key



Handbook 1 - file types

jpg, jpeg, gif, png, tif, tiff, bmp, pdf, mp3, wma



Handbook 2 - document types

Code Description
NATIONALID National ID
PASSPORT Passport
DRIVINGLICENCE Driving License
SOCIAL Social Security Number
ALIEN Alien Registration Number
ADDRESS Proof of Address
ISIC ISIC Card
PHOTOID Personal Photo with ID
OTHER Other



Handbook 3 - document fields

DocumentType FieldName Type Oblig Format Description
NATIONALID Number string * maxlen(255) Document number 1)
NATIONALID IssueDate date * yyyy-mm-dd Issue date
NATIONALID ExpiryDate date * yyyy-mm-dd Expiry date
NATIONALID IssuedBy string * maxlen(255) Issued by authority
NATIONALID CountryOfIssue int * maxlen(11) Country of Issue 2)
NATIONALID NumberInOriginalLanguage string * maxlen(255) Number In Original Language
NATIONALID DateOfBirth date * yyyy-mm-dd Date of birth
PASSPORT Number string * maxlen(255) Document number (see footnote 1)
PASSPORT IssueDate date * yyyy-mm-dd Issue date
PASSPORT ExpiryDate date * yyyy-mm-dd Expiry date
PASSPORT IssuedBy string * maxlen(255) Issued by authority
PASSPORT CountryOfIssue int * maxlen(11) Country of Issue (see footnote 2)
PASSPORT NumberInOriginalLanguage string * maxlen(255) Number In Original Language
PASSPORT DateOfBirth date * yyyy-mm-dd Date of birth
DRIVINGLICENCE Number string * maxlen(255) Document number (see footnote 1)
DRIVINGLICENCE IssueDate date * yyyy-mm-dd Issue date
DRIVINGLICENCE ExpiryDate date * yyyy-mm-dd Expiry date
DRIVINGLICENCE IssuedBy string * maxlen(255) Issued by authority
DRIVINGLICENCE CountryOfIssue int * maxlen(11) Country of Issue (see footnote 2)
DRIVINGLICENCE DateOfBirth date * yyyy-mm-dd Date of birth
ADDRESS IssueDate date * yyyy-mm-dd Issue date
ADDRESS ExpiryDate date * yyyy-mm-dd Expiry date
ADDRESS IssuedBy string * maxlen(255) Issued by authority
ADDRESS CountryOfIssue int * maxlen(11) Country of Issue (see footnote 2)
ADDRESS Address1 string * maxlen(255) Address (line1)
ADDRESS Address2 string * maxlen(255) Address (line2)
ADDRESS State string * maxlen(255) State
ADDRESS Country int * maxlen(11) Country (see footnote 2)
ADDRESS ZIP string * maxlen(255) ZIP/Postal code
ADDRESS City string * maxlen(255) City
OTHER Number string * maxlen(255) Document number (see footnote 1)
OTHER IssueDate date * yyyy-mm-dd Issue date
OTHER ExpiryDate date * yyyy-mm-dd Expiry date
OTHER IssuedBy string * maxlen(255) Issued by authority
OTHER CountryOfIssue int * maxlen(11) Country of Issue (see footnote 2)


1)
All number of documents must be passed in Latin character only!
2)
All country codes must be passed as ISO 3166-1 numeric code of country (http://en.wikipedia.org/wiki/ISO_3166-1_numeric) without leading zeros, for example 4 - Afghanistan not 004 - Afghanistan
uwcfsdocumentloader.1478095703.txt.gz · Last modified: 2016/11/02 14:08 by Dmitry Karpenko