Compliance & Risk
Evaluate Customer Risk Score Level#
evaluateCustomerRiskScore
This is a custom method used by certain partners to assess a customer's risk score level.
Permissions Required
Permissions are required for the agent to access this method.
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 |
| customerType | Integer | 1 | Yes | Fixed value "1" |
| customerResidenceCountry | String | 3 | Yes | ISO Alpha-3 (3166) |
| customerNationality | String | 3 | Yes | ISO Alpha-3 (3166) |
| expectedTurnover | Integer | 8 | Yes | Annual expected turnover |
| expectedReceiveCountries | String | 50 | Yes | Expected receiving countries (country ISO code). Separate by a comma for multivalue. E.g.: "GPR,QAT,EGY,IND" |
| expectedServiceTypes | String | 50 | Yes | Expected services-delivery types. Accepted values: 0035: CREDIT 0036: CASH 0069: CASH_TO_MOBILE 0074: CASH_TO_CARD Separate by a comma for multivalue. E.g.: " 0035,0036" |
| occupation | String | 100 | Yes | See get Occupations or sector |
| isPep | Integer | 1 | Yes | Customer is PEP? Accepted values: 1: Yes, 2: No |
| isLocatedHighRisk | Integer | 1 | Yes | Is located or has dealing to high-Risk jurisdiction? Accepted values: 1: Yes, 2: No |
| isAdverseMedia | Integer | 1 | Yes | Adverse Media considered as High Risk? Accepted values: 1: Yes, 2: No |
Response Outputs#
| Field | Type | Description |
|---|---|---|
| resultCode | String | See the Result Codes and Messages table |
| resultMessage | String | |
| riskValue | String | E.g. LOW, MEDIUM, HIGH |
SOAP Request#
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
<soapenv:Header/>
<soapenv:Body>
<web:evaluateCustomerRiskScore>
<isPep>2</isPep>
<isLocatedHighRisk>2</isLocatedHighRisk>
<isAdverseMedia>2</isAdverseMedia>
<expectedTurnover>1333</expectedTurnover>
<customerResidenceCountry>QAT</customerResidenceCountry>
<customerNationality>QAT</customerNationality>
<expectedReceiveCountries>QAT</expectedReceiveCountries>
<expectedServiceTypes>0036</expectedServiceTypes>
<occupation>Doctor</occupation>
<agentCode>*****</agentCode>
<userId>*****</userId>
<userPassword>*****</userPassword>
</web:evaluateCustomerRiskScore>
</soapenv:Body>
</soapenv:Envelope>
SOAP Response#
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:evaluateCustomerRiskScoreResponse 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:riskValue>Medium</ns2:riskValue>
</return>
</ns3:evaluateCustomerRiskScoreResponse>
</S:Body>
</S:Envelope>
Add Supportive Documents#
addSupportiveDocuments
This method is used to attach additional supportive documents to a remittance when requested by SHIFT Operations.
Maximum Documents
Maximum number of documents is 4.
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 |
| remittancTrackingCode | String | 20 | Yes | Country ISO Alpha3 |
| lstSupprotiveDocuments | List of Objects | Yes | Repeatable object for supportive documents. See below lstSupprotiveDocuments |
lstSupprotiveDocuments#
lstSupprotiveDocuments Object fields
| Field | Type | Size | Mandatory | Notes |
|---|---|---|---|---|
| documentName | String | 100 | Yes | Document name |
| documentFile | BASE64 | 200 | Yes | BASE64 format. Max file size 2MB |
| fileExtension | String | 3 | Yes | Allowed file formats: png, jpg, pdf |
Response Outputs#
| Field | Type | Description |
|---|---|---|
| resultCode | String | See the Result Codes and Messages table |
| resultMessage | String |
SOAP Request#
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/" xmlns:apis="http://xml.netbeans.org/schema/ApiSchema">
<soapenv:Header/>
<soapenv:Body>
<web:addSupportiveDocuments>
<remittancTrackingCode>42331177296</remittancTrackingCode>
<lstSupprotiveDocuments>
<apis:documentName>John Doe Source of Fund</apis:documentName>
<apis:documentFile>iVBORw0KGgoA.......</apis:documentFile>
<apis:fileExtension>PDF</apis:fileExtension>
</lstSupprotiveDocuments>
<agentCode>*****</agentCode>
<userId>*****</userId>
<userPassword>*****</userPassword>
</web:addSupportiveDocuments>
</soapenv:Body>
</soapenv:Envelope>
SOAP Response#
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:addSupportiveDocumentsResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
<return>
<ns2:resultCode>9000</ns2:resultCode>
<ns2:resultMessage>Operation successfully</ns2:resultMessage>
</return>
</ns3:addSupportiveDocumentsResponse>
</S:Body>
</S:Envelope>