Developers / API / Identity Verification
Identity Verification

Identity Verification

Identity Verification

Field Name Len Type Req Ver Comments
method N/A Alp-Num Yes 1.1 identityVerification
fromEmail N/A Alp-Num Yes 1.1 The email associated with the account from which the amount is deducted
toEmail N/A Alp-Num Yes 1.1 The email associated with the account where the amount is transfered to
firstName N/A Alp -- 1.1 First name + middle name
lastName N/A Alp -- 1.1 Last name
businessName N/A Alp-Num -- 1.2 Business name
gender 1 Num -- 1.1 0 = male
1 = female
address N/A Alp-Num -- 1.1 Street Address
city N/A Alp -- 1.1 City
state 2 / 3 Alp -- 1.1 two - tree letters state / province / county code (ISO 3166-2)
country 2 Alp -- 1.1 two letters country code (ISO Char 2 Code)
postalCode N/A Alp-Num -- 1.1 Zip / Postal Code
birthday 10 Date -- 1.1 Date of birth (yyyy-mm-dd)
phone 10 Num -- 1.1 Phone number (digits only)
idType 2 Num -- 1.1 3 = passport
4 = id card
5 = driver's license
10 = voter card
12 = state id
idNumber N/A Alp-Num -- 1.1 Document seris and number no spaces
key N/A Alp-Num -- 1.1 MD5(sharedSecret + toEmail + firstName + lastName + gender + address + city + state + country + postalCode + birthday + phone + idType + idNumber + businessName)(*if optional variables are missing, they should be left out of the key construction)

This request is responded by a message with the following content:

Field Name Len Type Mdt Ver Comments
ResponseCode N/A Alp-Num Yes 1.1 The response code; 00 = Success;
ResponseDescription N/A Alp-Num Yes 1.1 Human readable response
Fee N/A Real Yes 1.1 Fee for the current transaction
TransactionId N/A Num Yes 1.1 The transaction ID if successfully, otherwise not specified
Verification/ Email 1 Num Yes 1.1 4 = Not Matched ( and all the other fields are 0 = Not Checked )
2 = Matched
3 = Partial Matched
Verification/ FirstName 1 Num Yes 1.1 1 = Not Matched
2 = Matched
3 = Partial Matched
Verification/ LastName 1 Num Yes 1.1 1 = Not Matched
2 = Matched
3 = Partial Matched
Verification/ BusinessName 1 Num Yes 1.2 1 = Not Matched
2 = Matched
Verification/ Gender 1 Num Yes 1.1 1 = Not Matched
2 = Matched
Verification/ Address 1 Num Yes 1.1 1 = Not Matched (lower 35 %)
3 = Partial Matched (between 35 - 75 %)
2 = Matched (over 75 %)
Verification/ City 1 Num Yes 1.1 1 = Not Matched
2 = Matched
Verification/ State 1 Num Yes 1.1 1 = Not Matched
2 = Matched
4 = Not Found
Verification/ Country 1 Num Yes 1.1 1 = Not Matched
2 = Matched
Verification/ PostalCode 1 Num Yes 1.1 1 = Not Matched
2 = Matched
Verification/ Birthday 1 Num Yes 1.1 1 = Not Matched
2 = Matched
Verification/ Phone 1 Num Yes 1.1 1 = Not Matched
2 = Matched
Verification/ IdType 1 Num Yes 1.1 1 = Not Matched
2 = Matched
4 = Not Found
Verification/ IdNumber 1 Num Yes 1.1 0 = Not Checked (if IdType = 4)
1 = Not matched
2 = Matched

Request Sample:

https://www.paxum.com/payment/api/paymentAPI.php

POST

method=identityVerification&fromEmail=payee%40domain.com&toEmail=payer%40domain.com&firstName=firstName&lastName=lastName&businessName=businessName&gender=0&address=address&city=city&state=state&country=country&postalCode=123456&birthday=1970-01-01&phone=0123456789&idType=3&idNumber=123456&key=ec573a81ca2d4f236795db7118ac6f39

Response Sample

<?xml version="1.0"?>
<Response>
    <Environment>PRODUCTION</Environment>
	<Method>identityVerification</Method>
	<ResponseCode>00</ResponseCode>
	<ResponseDescription>Approved or Completed Successfully</ResponseDescription >
	<Fee>0.00</Fee>
	<TransactionId>23646236</TransactionId>
	<Verification>
		<Email>2</Email>
		<FirstName>1</FirstName>
		<LastName>2</LastName>
        <BusinessName>2</BusinessName>
		<Gender>2</Gender>
		<Address>3</Address>
		<City>2</City>
		<State>2</State>
		<Country>2</Country>
		<PostalCode>1</PostalCode>
		<Birthday>2</Birthday>
		<Phone>2</Phone>
		<IdType>4</IdType>
		<IdNumber>0</IdNumber>
	</Verification>
</Response>

Working Sample(s):

identityVerification.php

FAQ

1. How can I verify if an account is business or personal?

In order to verify if an account is business or personal you have to submit a value for the "businessName" field::
If in the response you receive: Email = 2 (matched) and

  • If BusinessName = 0 (not checked) – the account is Personal
  • If BusinessName = 1 (not matched) or 2 (matched) – the account is Business

So if somebody identifies to you as Business account submit the business name, otherwise submit the first and/or last name (or some random value) in the business name field then apply the algorithm above.

2. What will be the response if the account I verify has “Unverified” status in the system?

If you check the identity of a personal or business account which has status “Unverified” in our system, the result will be:

  • the Email will be 2 (Matched)
  • all the other fields will be 0 (Not Checked)