Pre Loading Data

Get Identities Types

getIdentities

This method returns a list of available identity types based on the customer type, the agent's country and the customer's nationality.

Identity Classification

Identities are classified into Citizen, Foreigner, and Company.
The available identities depend on the customer type, agent's country and the customer's nationality.

Customer Type 1:

• If the customer's nationality matches the agent's country, the system returns identities for a Citizen.
• Otherwise, the system returns identities for a Foreigner.

Customer Type 2:

• The system returns identities for a Company.

Request Inputs

Field	Type	Size	Mandatory	Description
agentCode	String	5	Yes	Agent code assigned by SHIFT
userId	String	20	Yes	User ID assigned by SHIFT
userPassword	String	30	Yes	User password assigned by SHIFT
customerType	Integer	1	Yes	See customer type table
countryCode	String	3	Yes	ISO Alpha-3 (3166) / Agent country
nationality	String	3	Conditional	Only required if customerType == 1 ISO Alpha-3 (3166) / Customer nationality

Response Outputs

Field	Type	Description
resultCode	String	See the Result Codes and Messages table
resultMessage	String
IdentitiesList	List of Objects	Contains identity type details. See below IdentitiesList

IdentitiesList

IdentitiesList Object fields

Field	Type	Size	Description
identityTypeCode	Integer	4
identityName	String	100
identitySeconderyName	String	100	Secondary name (local language)

SOAP Request

CitizenForeignerCompany

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
<soapenv:Header/>
<soapenv:Body>
    <web:getIdentities>
        <customerType>1</customerType>
        <countryCode>GBR</countryCode>
        <nationality>GBR</nationality>
        <agentCode>*****</agentCode>
        <userId>*****</userId>
        <userPassword>*****</userPassword>
    </web:getIdentities>
</soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
<soapenv:Header/>
<soapenv:Body>
    <web:getIdentities>
        <customerType>1</customerType>
        <countryCode>GBR</countryCode>
        <nationality>IND</nationality>
        <agentCode>*****</agentCode>
        <userId>*****</userId>
        <userPassword>*****</userPassword>
    </web:getIdentities>
</soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
<soapenv:Header/>
<soapenv:Body>
    <web:getIdentities>
        <customerType>2</customerType>
        <countryCode>GBR</countryCode>
        <nationality></nationality>
        <agentCode>*****</agentCode>
        <userId>*****</userId>
        <userPassword>*****</userPassword>
    </web:getIdentities>
</soapenv:Body>
</soapenv:Envelope>

SOAP Response

CitizenForeignerCompany

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns3:getIdentitiesResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
            <return>
                <ns2:resultCode>9000</ns2:resultCode>
                <ns2:resultMessage>Operation successfully</ns2:resultMessage>
                <ns2:IdentitiesList>
                    <ns2:identityTypeCode>2</ns2:identityTypeCode>
                    <ns2:identityName>National ID</ns2:identityName>
                    <ns2:identitySeconderyName></ns2:identitySeconderyName>
                </ns2:IdentitiesList>
                <ns2:IdentitiesList>
                    <ns2:identityTypeCode>3</ns2:identityTypeCode>
                    <ns2:identityName>Driving License</ns2:identityName>
                    <ns2:identitySeconderyName></ns2:identitySeconderyName>
                </ns2:IdentitiesList>
            </return>
        </ns3:getIdentitiesResponse>
    </S:Body>
</S:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns3:getIdentitiesResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
            <return>
                <ns2:resultCode>9000</ns2:resultCode>
                <ns2:resultMessage>Operation successfully</ns2:resultMessage>
                <ns2:IdentitiesList>
                    <ns2:identityTypeCode>1</ns2:identityTypeCode>
                    <ns2:identityName>Passport</ns2:identityName>
                    <ns2:identitySeconderyName></ns2:identitySeconderyName>
                </ns2:IdentitiesList>
                <ns2:IdentitiesList>
                    <ns2:identityTypeCode>4</ns2:identityTypeCode>
                    <ns2:identityName>Residency Card</ns2:identityName>
                    <ns2:identitySeconderyName></ns2:identitySeconderyName>
                </ns2:IdentitiesList>
            </return>                    
        </ns3:getIdentitiesResponse>
    </S:Body>
</S:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns3:getIdentitiesResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
            <return>
                <ns2:resultCode>9000</ns2:resultCode>
                <ns2:resultMessage>Operation successfully</ns2:resultMessage>
                <ns2:IdentitiesList>
                    <ns2:identityTypeCode>31</ns2:identityTypeCode>
                    <ns2:identityName>Commercial registration</ns2:identityName>
                    <ns2:identitySeconderyName></ns2:identitySeconderyName>
                </ns2:IdentitiesList>
            </return>
        </ns3:getIdentitiesResponse>
    </S:Body>
</S:Envelope>

---

Get Occupations or Sectors

getOccupationsOrSectors

This method retrieves a list of customer occupations and sectors based on the customer's type.

Request Inputs

Field	Type	Size	Mandatory	Description
agentCode	String	5	Yes	Agent code assigned by SHIFT
userId	String	20	Yes	User ID assigned by SHIFT
userPassword	String	30	Yes	User password assigned by SHIFT
customerType	String	20	Yes	See the customer types table

Response Outputs

Field	Type	Description
resultCode	String	See the Result Codes and Messages table
resultMessage	String
name	List of Strings	Contains occupation/sector names.

SOAP Request

customerType == 1customerType == 2

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
<soapenv:Header/>
<soapenv:Body>
    <web:getOccupationsOrSectors>
        <customerType>1</customerType>
        <agentCode>*****</agentCode>
        <userId>*****</userId>
        <userPassword>*****</userPassword>
    </web:getOccupationsOrSectors>
</soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
<soapenv:Header/>
<soapenv:Body>
    <web:getOccupationsOrSectors>
        <customerType>2</customerType>
        <agentCode>*****</agentCode>
        <userId>*****</userId>
        <userPassword>*****</userPassword>
    </web:getOccupationsOrSectors>
</soapenv:Body>
</soapenv:Envelope>

SOAP Response

customerType == 1customerType == 2

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
    <ns3:getOccupationsOrSectorsResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
        <return>
            <ns2:resultCode>9000</ns2:resultCode>
            <ns2:resultMessage>Operation successfully</ns2:resultMessage>
            <ns2:name>Doctor</ns2:name>
            <ns2:name>Pharmacist</ns2:name>
            <ns2:name>Engineer</ns2:name>
            <ns2:name>Consultant</ns2:name>
            <ns2:name>Officer</ns2:name>
            <ns2:name>Lawyer</ns2:name>
            <ns2:name>Teacher</ns2:name>
            <ns2:name>Accountant</ns2:name>
            <ns2:name>Mechanical</ns2:name>
            <ns2:name>Trader</ns2:name>
            <ns2:name>Student</ns2:name>
            <ns2:name>Employee with a contract</ns2:name>
            <ns2:name>Self Employed</ns2:name>
            <ns2:name>Unemployed</ns2:name>
            <ns2:name>Retired</ns2:name>
            <ns2:name>Chef</ns2:name>
            <ns2:name>Pilot</ns2:name>
            <ns2:name>Driver</ns2:name>
            <ns2:name>Technical</ns2:name>
            <ns2:name>Artist</ns2:name>
            <ns2:name>Fitter</ns2:name>
            <ns2:name>Media</ns2:name>
            <ns2:name>Farmer</ns2:name>
            <ns2:name>House wife</ns2:name>
        </return>
    </ns3:getOccupationsOrSectorsResponse>
</S:Body>
</S:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
    <ns3:getOccupationsOrSectorsResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
        <return>
            <ns2:resultCode>9000</ns2:resultCode>
            <ns2:resultMessage>Operation successfully</ns2:resultMessage>
            <ns2:name>Medical Equipment</ns2:name>
            <ns2:name>industrial equipment</ns2:name>
            <ns2:name>Agricultural equipment</ns2:name>
            <ns2:name>Chemical equipment</ns2:name>
            <ns2:name>Mechanics</ns2:name>
            <ns2:name>Electronics</ns2:name>
            <ns2:name>Technical equipment</ns2:name>
            <ns2:name>Media</ns2:name>
            <ns2:name>Education</ns2:name>
            <ns2:name>Marketing</ns2:name>
            <ns2:name>Export</ns2:name>
            <ns2:name>Import</ns2:name>
            <ns2:name>Financial services</ns2:name>
            <ns2:name>Trade</ns2:name>
            <ns2:name>Shipping</ns2:name>
            <ns2:name>Vehicles</ns2:name>
            <ns2:name>Machines</ns2:name>
            <ns2:name>Aviation</ns2:name>
            <ns2:name>Hotels</ns2:name>
            <ns2:name>Real state</ns2:name>
            <ns2:name>Precious metals</ns2:name>
            <ns2:name>Tourism</ns2:name>
            <ns2:name>Antiques and Antiquities</ns2:name>
            <ns2:name>Engineering</ns2:name>
            <ns2:name>Art</ns2:name>
            <ns2:name>Investments</ns2:name>
            <ns2:name>Supply Services</ns2:name>
            <ns2:name>Insurance</ns2:name>
            <ns2:name>Consulting</ns2:name>
            <ns2:name>Private sector</ns2:name>
            <ns2:name>Governmental sector</ns2:name>
        </return>
    </ns3:getOccupationsOrSectorsResponse>
</S:Body>
</S:Envelope>

---

Get Source Of Fund List

getSourceOfFundList

This method retrieves a list of customer sources of fund.

Request Inputs

Field	Type	Size	Mandatory	Description
agentCode	String	5	Yes	Send Agent code assigned by SHIFT
userId	String	20	Yes	User ID assigned by SHIFT
userPassword	String	30	Yes	User password assigned by SHIFT

Response Outputs

Field	Type	Description
resultCode	String	See the Result Codes and Messages table
resultMessage	String
name	List of Strings	contains source of fund names.

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:getSourceOfFundList>
         <agentCode>*****</agentCode>
         <userId>*****</userId>
         <userPassword>*****</userPassword>
      </web:getSourceOfFundList>
   </soapenv:Body>
</soapenv:Envelope>

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns3:getSourceOfFundListResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
            <return>
                <ns2:resultCode>9000</ns2:resultCode>
                <ns2:resultMessage>Operation successfully</ns2:resultMessage>
                <ns2:name>Salary saving</ns2:name>
                <ns2:name>Salary</ns2:name>
                <ns2:name>Family associates</ns2:name>
                <ns2:name>Gift</ns2:name>
                <ns2:name>Business</ns2:name>
                <ns2:name>Financial market</ns2:name>
                <ns2:name>End of service benefit</ns2:name>
                <ns2:name>Bank Loan</ns2:name>
                <ns2:name>Legal compensation</ns2:name>
                <ns2:name>Real estate</ns2:name>
            </return>
        </ns3:getSourceOfFundListResponse>
    </S:Body>
</S:Envelope>

---

Get Relationship List

getRelationshipList

This method retrieves a list of customer relationships.

Request Inputs

Field	Type	Size	Mandatory	Description
agentCode	String	5	Yes	Send Agent code assigned by SHIFT
userId	String	20	Yes	User ID assigned by SHIFT
userPassword	String	30	Yes	User password assigned by SHIFT

Response Outputs

Field	Type	Description
resultCode	String	See the Result Codes and Messages table
resultMessage	String
name	List of Strings	contains relationship names.

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:getRelationshipList>
         <agentCode>*****</agentCode>
         <userId>*****</userId>
         <userPassword>*****</userPassword>
      </web:getRelationshipList>
   </soapenv:Body>
</soapenv:Envelope>

SOAP Responsee

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns3:getRelationshipListResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
            <return>
                <ns2:resultCode>9000</ns2:resultCode>
                <ns2:resultMessage>Operation successfully</ns2:resultMessage>
                <ns2:name>Family member</ns2:name>
                <ns2:name>Friend</ns2:name>
                <ns2:name>Business</ns2:name>
            </return>
        </ns3:getRelationshipListResponse>
    </S:Body>
</S:Envelope>

---

Get Country Info

getCountryInfo

This method is used to retrieve country-specific information, including general restrictions and rules.

Request Inputs

Field	Type	Size	Mandatory	Description
agentCode	String	5	Yes	Agent code assigned by SHIFT
userId	String	20	Yes	User ID assigned by SHIFT
userPassword	String	30	Yes	User password assigned by SHIFT
countryCode	String	3	Yes	ISO Alpha3

Response Outputs

Field	Type	Description
resultCode	String	See the Result Codes and Messages table
resultMessage	String
countryInfo	Object	Country information. See below countryInfo

countryInfo

countryInfo Object fields

Field	Type	Description
legalAge	Integer
generalRules	String
restrictions	String
idLimit	Integer
sendingLimitCashPickup	Integer
receivingLimitCashPickup	Integer
sendingLimitAccountDeposit	Integer
receivingLimitAccountDeposit	Integer
sendingLimitCashToMobile	Integer
receivingLimitCashToMobile	Integer
sendingLimitCashToDoor	Integer
receivingLimitCashToDoor	Integer
sendingLimitCashToCard	Integer
receivingLimitCashToCard	Integer
taxPercent	Decimal
taxNameEnglish	String
taxNameSecondary	String
taxInfo	String

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:getCountryInfo>
         <countryCode>GBR</countryCode>
         <agentCode>*****</agentCode>
         <userId>*****</userId>
         <userPassword>*****</userPassword>
      </web:getCountryInfo>
   </soapenv:Body>
</soapenv:Envelope>

SOAP Request

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns3:getCountryInfoResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
            <return>
                <ns2:resultCode>9000</ns2:resultCode>
                <ns2:resultMessage>Operation successfully</ns2:resultMessage>
                <ns2:CountryInfo>
                    <ns2:legalAge>18</ns2:legalAge>
                    <ns2:taxPercent>0.0</ns2:taxPercent>
                    <ns2:generalRules>> Pay-out Currency: 
         GBP 
> Working days: 
     Monday to Friday

> Service type: 
     Cash pickup  
     Account deposit</ns2:generalRules>
                    <ns2:restrictions>> Account deposit specifications:
     . IBAN is Manadatory for the remittances sent to account
     . A valid receiver number is highly important to fill in the details.
     . Individual and Commercial transactions are allowed. Reference - invoice number must be added to the details for commercial transactions.
     . Commercial transactions take up to 72 working hours to be deposited</ns2:restrictions>
                    <ns2:idLimit>1</ns2:idLimit>
                    <ns2:sendingLimitCashPickup>5000</ns2:sendingLimitCashPickup>
                    <ns2:receivingLimitCashPickup>5000</ns2:receivingLimitCashPickup>
                    <ns2:sendingLimitAccountDeposit>15000</ns2:sendingLimitAccountDeposit>
                    <ns2:receivingLimitAccountDeposit>15000</ns2:receivingLimitAccountDeposit>
                    <ns2:sendingLimitCashToMobile>2000</ns2:sendingLimitCashToMobile>
                    <ns2:receivingLimitCashToMobile>1</ns2:receivingLimitCashToMobile>
                    <ns2:sendingLimitCashToDoor>1</ns2:sendingLimitCashToDoor>
                    <ns2:receivingLimitCashToDoor>1</ns2:receivingLimitCashToDoor>
                    <ns2:sendingLimitCashToCard>4900</ns2:sendingLimitCashToCard>
                    <ns2:receivingLimitCashToCard>1</ns2:receivingLimitCashToCard>
                </ns2:CountryInfo>
            </return>
        </ns3:getCountryInfoResponse>
    </S:Body>
</S:Envelope>