Skip to content
Connect API Catalog/
/
/
Revalidate A Given Identi...

Revalidate A Given Identity Search With Additional Documents

Request

Revalidate's a given identity search with additional documents.

Security
bearerToken
Path
uniqueIdstringrequired

The ID of the record to update

Bodyapplication/jsonrequired
uniqueIdstring or null
passportobject(ConnectIdentityPassport)

This object may contain any number of properties. The properties included can vary, for example by country or data provider.

driversLicenseobject(ConnectIdentityDriversLicense)

This object may contain any number of properties. The properties included can vary, for example by country or data provider.

electricitySupplierobject(ConnectIdentityElectricitySupplier)

This object may contain any number of properties. The properties included can vary, for example by country or data provider.

europeanIDCardobject(ConnectIdentityEuropeanIDCard)

This object may contain any number of properties. The properties included can vary, for example by country or data provider.

niNumberobject(ConnectIdentityNINumber)

This object may contain any number of properties. The properties included can vary, for example by country or data provider.

bankAccountDetailsobject(ConnectIdentityBankAccountDetails)

This object may contain any number of properties. The properties included can vary, for example by country or data provider.

curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch/revalidation/{uniqueId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "uniqueId": "string",
    "passport": {},
    "driversLicense": {},
    "electricitySupplier": {},
    "europeanIDCard": {},
    "niNumber": {},
    "bankAccountDetails": {}
  }'

Responses

Success

Bodyapplication/json
correlationIdstring

A unique ID assigned to this request.

uniqueIdstring
inputobject(ConnectIdentityAMLSearchRequest)

The input data submitted for the AML search, detailing the information used to initiate the search.

commonobject(ConnectIdentityCommonResult)

General results from the search that are applicable across different types of identity checks.

consumerobject(ConnectIdentitySupplierResult)
idobject(ConnectIdentitySupplierResult)
amlResultobject(ConnectIdentitySupplierResult)
bankMatchobject(ConnectIdentitySupplierResult)
picklistArray of objects or null(ConnectIdentitypicklist)
messagestring or null
errorsobject or null
Response
{
  "correlationId": "string",
  "uniqueId": "string",
  "input": {
    "uniqueId": "string",
    "common": { … },
    "idAml": { … },
    "products": [ … ]
  },
  "common": {
    "customerId": 0,
    "userId": 0,
    "uniqueId": "string",
    "searchText": "string",
    "reference": "string",
    "searchTime": "2019-08-24T14:15:22Z"
  },
  "consumer": {
    "success": true,
    "supplierId": "string",
    "supplierOriginalId": "string",
    "creditsIncurred": 0
  },
  "id": {
    "success": true,
    "supplierId": "string",
    "supplierOriginalId": "string",
    "creditsIncurred": 0
  },
  "amlResult": {
    "success": true,
    "supplierId": "string",
    "supplierOriginalId": "string",
    "creditsIncurred": 0
  },
  "bankMatch": {
    "success": true,
    "supplierId": "string",
    "supplierOriginalId": "string",
    "creditsIncurred": 0
  },
  "picklist": [
    { … }
  ],
  "message": "string",
  "errors": {
    "property1": [ … ],
    "property2": [ … ]
  }
}