Docs
Developer Hub

Step Completed: PH to PR

Suggest Edits

phone-ownership-validation

Step Completed

"step" : {
  "status" : 200, 
  "id" : "phone-ownership-validation", 
  "data" : {
    "phoneNumber" : "0000000000", 
    "countryCode" : "MX", 
    "dialingCode" : 52
  }, 
  "error" : null
}

Step Error

"step" : {
  "status" : 200, 
  "id" : "phone-ownership-validation", 
  "error" : {
    "type" : "StepError", 
    "code" : "phoneOwnership.notEnoughParams", 
    "message" : "User has not submitted any valid phone within given time"
  }
}

"step" : {
  "status" : 200, 
  "id" : "phone-ownership-validation", 
  "data" : {
    "phoneNumber" : "000000000", 
    "countryCode" : "CL", 
    "dialingCode" : 56
  }, 
  "error" : {
    "type" : "StepError", 
    "code" : "phoneOwnership.unconfirmed", 
    "message" : "User has not submitted confirmation code for phone entered within given time"
  }
}

"step" : {
  "status" : 200, 
  "id" : "phone-ownership-validation", 
  "error" : {
    "type" : "StepError", 
    "code" : "phoneOwnership.skipped", 
    "message" : "User skipped this step"
  }
}

phone-risk-analysis-validation

Step Completed

"status" : 200, 
            "id" : "phone-risk-analysis-validation", 
            "error" : null, 
            "data" : {
                "phoneNumber" : "0000000000", 
                "dialingCode" : 52, 
                "countryCode" : "MX", 
                "phoneType" : "Mobile", 
                "phoneTypeStatus" : "Allowed", 
                "riskLevel" : "very-low", 
                "riskInsights" : [
                    {
                        "name" : "regular activity", 
                        "description" : "Most trustworthy category, based on past behavior.", 
                        "impact" : "Positive", 
                        "type" : "Category"
                    }, 
                    {
                        "name" : "no range activity", 
                        "description" : "Very little activity, or none at all, for a risky range that this number belongs to over the past 90 days. Also returned if the number does not belong to a risky range.", 
                        "impact" : "Positive", 
                        "type" : "Automation to human activity"
                    }, 
                    {
                        "name" : "seen in the last 3 months", 
                        "description" : "Activity on this number in the last three months.", 
                        "impact" : "Neutral", 
                        "type" : "Human to human activity"
                    }, 
                    {
                        "name" : "low number of completed calls", 
                        "description" : "Less success than expected for this number over the past 90 days.", 
                        "impact" : "Negative", 
                        "type" : "Human to human activity"
                    }, 
                    {
                        "name" : "regular call duration", 
                        "description" : "Expected call duration for this number over the past 90 days.", 
                        "impact" : "Positive", 
                        "type" : "Human to human activity"
                    }, 
                    {
                        "name" : "sparse long-term activity", 
                        "description" : "Lower than expected activity on this number over a tenure greater than or equal to one week (long-term).", 
                        "impact" : "Positive", 
                        "type" : "Human to human activity"
                    }, 
                    {
                        "name" : "no range activity", 
                        "description" : "Very little activity, or none at all, for a risky range that this number belongs to over the past 90 days. Also returned if the number does not belong to a risky range.", 
                        "impact" : "Positive", 
                        "type" : "Human to human activity"
                    }
                ], 
                "riskScore" : 16, 
                "maxPossibleRiskScore" : 100, 
                "recommendation" : "allow", 
                "timezone" : "-6", 
                "lineType" : "MOBILE", 
                "carrier" : "Radiomovil Dipsa, S.A. De C.V.", 
                "location" : {
                    "city" : "Cuauhtemoc", 
                    "state" : null, 
                    "zip" : null, 
                    "metroCode" : null, 
                    "county" : null, 
                    "country" : "Mexico"
                }
            }
        },

Step Error

"step" : {
  "status" : 200, 
  "id" : "phone-risk-analysis-validation", 
  "error" : {
    "type" : "StepError", 
    "code" : "input.failed", 
    "message" : "Cannot meet dependent input"
  }
}

"step" : {
            "status" : 200, 
            "id" : "phone-risk-analysis-validation", 
            "error" : {
                "type" : "StepError", 
                "code" : "phoneRisk.highRisk", 
                "message" : "The phone number that the user provided appears have suspicious behavior and properties"
            }, 
            "data" : {
                "phoneNumber" : "0000000000", 
                "dialingCode" : 57, 
                "countryCode" : "CO", 
                "phoneType" : "Mobile", 
                "phoneTypeStatus" : "Allowed", 
                "riskLevel" : "very-high", 
                "riskInsights" : [
                    {
                        "name" : "high-risk irregular activity", 
                        "description" : "Highest-risk category, based on past behavior.", 
                        "impact" : "Negative", 
                        "type" : "Category"
                    }, 
                    {
                        "name" : "high short-term range activity", 
                        "description" : "Very significant activity for a risky range that this number belongs to over the last 24 hours.", 
                        "impact" : "Negative", 
                        "type" : "Automation to human activity"
                    }, 
                    {
                        "name" : "seen in the last 2 months", 
                        "description" : "Activity on this number in the last two months.", 
                        "impact" : "Neutral", 
                        "type" : "Human to human activity"
                    }, 
                    {
                        "name" : "very low number of completed calls", 
                        "description" : "Much less success than expected, or no success at all, for this number over the past 90 days.", 
                        "impact" : "Negative", 
                        "type" : "Human to human activity"
                    }, 
                    {
                        "name" : "irregular call duration", 
                        "description" : "Shorter or longer than expected call duration for this number over the past 90 days.", 
                        "impact" : "Negative", 
                        "type" : "Human to human activity"
                    }, 
                    {
                        "name" : "sparse long-term activity", 
                        "description" : "Lower than expected activity on this number over a tenure greater than or equal to one week (long-term).", 
                        "impact" : "Positive", 
                        "type" : "Human to human activity"
                    }, 
                    {
                        "name" : "no range activity", 
                        "description" : "Very little activity, or none at all, for a risky range that this number belongs to over the past 90 days. Also returned if the number does not belong to a risky range.", 
                        "impact" : "Positive", 
                        "type" : "Human to human activity"
                    }
                ], 
                "riskScore" : 83, 
                "maxPossibleRiskScore" : 100, 
                "recommendation" : "block", 
                "timezone" : "-5", 
                "lineType" : "MOBILE", 
                "carrier" : "Comcel", 
                "location" : {
                    "city" : "Countrywide", 
                    "state" : null, 
                    "zip" : null, 
                    "metroCode" : null, 
                    "county" : null, 
                    "country" : "Colombia"
                }
            }
        },

"step" : {
  "status" : 200, 
  "id" : "phone-risk-analysis-validation", 
  "error" : {
    "type" : "StepError", 
    "code" : "phoneRisk.serviceUnavailable", 
    "message" : "Service unavailable"
  }
}

"step" : {
  "status" : 200, 
  "id" : "phone-risk-analysis-validation", 
  "error" : {
    "type" : "StepError", 
    "code" : "phoneRisk.skipped", 
    "message" : "User skipped this step"
  }
}

"step" : {
            "status" : 200, 
            "id" : "phone-risk-analysis-validation", 
            "error" : {
                "type" : "StepError", 
                "code" : "phoneRisk.phoneTypeStatusBlocked", 
                "message" : "The phone number with a blocked type"
            }, 
            "data" : {
                "phoneNumber" : "0000000000", 
                "dialingCode" : 1, 
                "countryCode" : "US", 
                "phoneType" : "Voip", 
                "phoneTypeStatus" : "Blocked", 
                "riskLevel" : "medium", 
                "riskInsights" : [
                    {
                        "name" : "irregular number type", 
                        "description" : "This number has risky static attributes (like VOIP phone type or being on a blocklist).", 
                        "impact" : "Negative", 
                        "type" : "Category"
                    }, 
                    {
                        "name" : "no range activity", 
                        "description" : "Very little activity, or none at all, for a risky range that this number belongs to over the past 90 days. Also returned if the number does not belong to a risky range.", 
                        "impact" : "Positive", 
                        "type" : "Automation to human activity"
                    }, 
                    {
                        "name" : "no activity", 
                        "description" : "Very little activity, or none at all, was ever observed on this number. Very short tenure. Cannot classify.", 
                        "impact" : "Neutral", 
                        "type" : "Human to human activity"
                    }, 
                    {
                        "name" : "VOIP number", 
                        "description" : "This is a VOIP number.", 
                        "impact" : "Negative", 
                        "type" : "Number type"
                    }, 
                    {
                        "name" : "medium-risk carrier", 
                        "description" : "This number is associated with a risky carrier.", 
                        "impact" : "Negative", 
                        "type" : "Number type"
                    }
                ], 
                "riskScore" : 50, 
                "maxPossibleRiskScore" : 100, 
                "recommendation" : "flag", 
                "timezone" : "-5", 
                "lineType" : "VOIP", 
                "carrier" : "Google (Grand Central) - SVR", 
                "location" : {
                    "city" : "Boynton Beach", 
                    "state" : "FL", 
                    "zip" : "33435", 
                    "metroCode" : "8960", 
                    "county" : "Palm Beach", 
                    "country" : "United States"
                }
            }
        },

premium-aml-watchlists-search-validation

Step Completed

"step" : {
  "status" : 200, 
  "id" : "premium-aml-watchlists-search-validation", 
  "error" : null, 
    "data" : {
    "searchedOn" : "2021-08-15 00:00:11", 
    "nameSearched" : "JANE DOE", 
    "profileUrl" : "https://app.complyadvantage.com/public/search/XXXX/XXXX", 
    "searchId" : 000000000
  }
}

Step Error

"step" : {
  "status" : 200, 
  "id" : "premium-aml-watchlists-search-validation", 
  "error" : {
    "type" : "StepError", 
    "code" : "premiumAmlWatchlists.notValidParams", 
    "message" : "Full Name is not defined"
  }
}

"step" : {
  "status" : 200, 
  "id" : "premium-aml-watchlists-search-validation", 
  "error" : {
    "type" : "SafetyCheckError", 
    "code" : "premiumAmlWatchlists.matchFound"
  }, 
  "data" : {
    "searchedOn" : "2021-08-15 00:42:41", 
    "nameSearched" : "JOHN DOE", 
    "profileUrl" : "https://app.complyadvantage.com/public/search/XXXX/XXXX", 
    "searchId" : 000000000
  }
}

"step" : {
  "status" : 200, 
  "id" : "premium-aml-watchlists-search-validation", 
  "error" : {
    "type" : "StepError", 
    "code" : "input.failed", 
    "message" : "Cannot meet dependent input"
  }
}

"step" : {
  "status" : 200, 
  "id" : "premium-aml-watchlists-search-validation", 
  "error" : {
    "type" : "StepError", 
    "code" : "node.failed", 
    "message" : "Cannot meet dependent node"
  }, 
  "documentType" : "national-id"
}

System Error

"step" : {
  "status" : 200, 
  "id" : "premium-aml-watchlists-search-validation", 
  "error" : {
    "type" : "SystemError", 
    "code" : "system.internalError", 
    "message" : "webScraper.getComplyAdvantageData.failed"
  }
}

premium-aml-watchlists-validation

Step Completed

"step": {
  "status": 200,
  "id": "premium-aml-watchlists-validation",
  "error": null,
  "data": [
    {
      "nameSearched": "John Doe",
      "profileUrl": "https://app.complyadvantage.com/public/search/00000000000000",
      "searchedOn": "2022-07-29 12:53:55",
      "searchId": 0000000000,
      "originalMatchStatus": "no_match",
      "countriesSearched": ["AF"],
      "birthYear": 1970,
      "dataSource": "custom-fields",
      "matchFound": false,
      "monitored": true
    }
  ]
}

Step Error

"step": {
  "status": 200, 
  "id": "premium-aml-watchlists-validation", 
  "error": {
    "type": "StepError", 
    "code": "node.failed", 
    "message": "Cannot meet dependent node"
  }
}

"step": {
  "status": 200,
  "id": "premium-aml-watchlists-validation",
  "error": {
    "type": "StepError",
    "code": "premiumAmlWatchlists.notEnoughParams",
    "message": "Not enough data to perform the search"
  },
  "data": [
    {
      "birthYear": null,
      "country": "MX",
      "documentType": "passport",
      "name": null,
      "error": {
        "type": "StepError",
        "code": "premiumAmlWatchlists.notEnoughParams",
        "message": "Not enough data to perform the search"
      },
      "dataSource": "document-data"
    },
    {
      "nameSearched": "John Doe",
      "profileUrl": "https://app.complyadvantage.com/public/search/00000000000000",
      "searchedOn": "2022-07-29 14:19:51",
      "searchId": 0000000000,
      "originalMatchStatus": "no_match",
      "countriesSearched": ["CA"],
      "birthYear": 1980,
      "country": "CO",
      "documentType": "national-id",
      "dataSource": "document-data",
      "matchFound": false
    }
  ]
}

"step": {
  "status": 200,
  "id": "premium-aml-watchlists-validation",
  "error": {
    "type": "StepError",
    "code": "premiumAmlWatchlists.matchFound",
    "message": "Match found with the passport"
  },
  "data": [
    {
      "nameSearched": "John Doe",
      "profileUrl": "https://app.complyadvantage.com/public/search/00000000000000",
      "searchedOn": "2022-07-29 14:12:32",
      "searchId": 0000000000,
      "originalMatchStatus": "potential_match",
      "birthYear": 1990,
      "country": "MX",
      "documentType": "passport",
      "dataSource": "document-data",
      "matchFound": true
    },
    {
      "nameSearched": "Jack Doe",
      "profileUrl": "https://app.complyadvantage.com/public/search/00000000000001",
      "searchedOn": "2022-07-29 14:12:32",
      "searchId": 0000000001,
      "originalMatchStatus": "no_match",
      "birthYear": 1980,
      "country": "CO",
      "documentType": "national-id",
      "dataSource": "document-data",
      "matchFound": false
    }
  ]
}

{
	"status": 200,
	"id": "premium-aml-watchlists-validation",
	"error": {
		"code": "StepError",
	  "type": "premiumAmlWatchlists.matchFound",
	  "message": "Match found with the custom-fields"
	},
	"data": [
		{
			"searchedOn": "2022-01-31 11:07:45",
			"nameSearched": "Some Name",
			"profileUrl": "https://link.to/comply-advantage/profile/3",
			"searchId": 333333333,
			"originalMatchStatus": "no_match",
			"dataSource" : "custom-fields",
			"matchFound": true
		}
	]
}

System Error

"step": {
  "status": 200, 
  "id": "premium-aml-watchlists-validation", 
  "error": {
    "type": "SystemError", 
    "code": "system.internalError", 
    "message": "Step timeout"
  

"step": {
  "status": 200, 
  "id": "premium-aml-watchlists-validation", 
  "error": {
    "type": "SystemError", 
    "code": "system.internalError", 
    "message": "Internal error"
  }
}

Premium-aml-watchlists-validation Monitor true happened


 {
   "data":{
      "searchId":123456789,
      "nameSearched":"Full Name",
      "searchedOn":"2022-03-01 00:00:00",
      "updatedOn":"2022-03-02 00:00:00",
      "message":"This monitored search has received an update, please review the profileUrl",
      "profileUrl":"https://app.complyadvantage.com/public/search/1234567890-abcdef1g/xxxxxxxx"
   }
}

proof-of-ownership

Step Completed

"step" : {
  "status" : 200, 
  "id" : "proof-of-ownership", 
  "data" : {
    "documentType" : "national-id", 
    "selfiePhotoWithDocumentUrl" : "http://media-server/media/selfie/XXXX.jpeg"
  }, 
  "error" : null
}

Step Error

"step" : {
  "status" : 200, 
  "id" : "proof-of-ownership", 
  "error" : {
    "type" : "StepError", 
    "code" : "input.failed", 
    "message" : "Cannot meet dependent input"
  }
}

"step" : {
  "status" : 200, 
  "id" : "proof-of-ownership", 
  "data" : {
    "documentType" : "national-id", 
    "selfiePhotoWithDocumentUrl" : "http://media-server/media/selfie/XXXX.jpeg"
  }, 
  "error" : {
    "type" : "StepError", 
    "code" : "proofOfOwnership.differentPerson", 
    "message" : "There are different persons on photos"
  }
}

"step" : {
  "status" : 200, 
  "id" : "proof-of-ownership", 
  "data" : {
    "documentType" : "national-id", 
    "selfiePhotoWithDocumentUrl" : "http://media-server/media/selfie/XXXX.jpeg"
  }, 
  "error" : {
    "type" : "StepError", 
    "code" : "proofOfOwnership.notConfidentComparison", 
    "message" : "The person on photos might not be the same"
  }
}

"step" : {
  "status" : 200, 
  "id" : "proof-of-ownership", 
  "error" : {
    "type" : "StepError", 
    "code" : "node.failed", 
    "message" : "Cannot meet dependent node"
  }
}

Updated 8 months ago