Skip to main content
PATCH
/
v2
/
individuals
/
{entityId}
/
results
/
idv
Update the status of IDV process results
curl --request PATCH \
  --url https://api.uat.frankie.one/v2/individuals/{entityId}/results/idv \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "processResults": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "comment": {
    "text": "Update after speaking to customer over the phone directly.",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}
'
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "processResults": [
    {
      "processResultId": "<string>",
      "schemaVersion": 123,
      "entityId": "<string>",
      "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
      "stepName": "<string>",
      "stepType": "<string>",
      "objectType": "<string>",
      "objectId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "groupId": "<string>",
      "providerResult": {
        "name": "<string>",
        "source": "<string>",
        "sourceNormalized": "<string>",
        "reference": "<string>",
        "fuzziness": {
          "normalized": 50,
          "actual": "<string>"
        },
        "confidence": {
          "normalized": 50,
          "actual": "<string>"
        },
        "riskScore": 123,
        "errorCode": "<string>",
        "errorMessage": "<string>"
      },
      "subClass": "<string>",
      "supplementaryData": {
        "serviceProvider": "<string>",
        "searchId": "<string>",
        "caseId": "<string>",
        "referenceId": "<string>",
        "originalStepSearchLevel": "<string>",
        "groupingId": "<string>",
        "reportUrl": "<string>",
        "fuzziness": {
          "normalized": 50,
          "actual": "<string>"
        },
        "matchData": {
          "spReferenceId": "<string>",
          "name": "<string>",
          "strength": 123,
          "givenName": "<string>",
          "otherName": "<string>",
          "familyName": "<string>",
          "date": "<string>",
          "address": "<string>",
          "countries": [
            {
              "code": "<string>",
              "matchType": "<string>"
            }
          ],
          "nationalId": {
            "idNumber": "<string>",
            "idType": "<string>",
            "idExpiry": "<string>",
            "issuingCountryCode": "<string>",
            "documentId": "<string>"
          },
          "imageUrl": "<string>",
          "isDeceased": true,
          "isAlias": true,
          "isRelated": true
        },
        "aliases": [
          "<string>"
        ],
        "relatedParties": [
          {
            "name": "<string>",
            "relationship": "<string>"
          }
        ],
        "referenceDocs": [
          {
            "url": "<string>",
            "description": "<string>"
          }
        ],
        "notes": {},
        "pepData": [
          {
            "countryCode": "<string>",
            "countryName": "<string>",
            "sourceName": "<string>",
            "level": "<string>",
            "sourceUrl": "<string>",
            "sourcePosition": "<string>",
            "position": "<string>",
            "positionDescription": "<string>",
            "status": "<string>",
            "listingStart": "<string>",
            "listingEnd": "<string>",
            "imageUrl": "<string>",
            "referenceDocs": [
              {
                "url": "<string>",
                "description": "<string>"
              }
            ],
            "additionalData": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ]
          }
        ],
        "sanctionData": [
          {
            "countryCode": "<string>",
            "countryName": "<string>",
            "sourceName": "<string>",
            "sourceUrl": "<string>",
            "sourceReason": "<string>",
            "listingStart": "<string>",
            "listingEnd": "<string>",
            "imageUrl": "<string>",
            "referenceDocs": [
              {
                "url": "<string>",
                "description": "<string>"
              }
            ],
            "additionalData": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ]
          }
        ],
        "watchlistData": [
          {
            "countryCode": "<string>",
            "countryName": "<string>",
            "sourceName": "<string>",
            "sourceUrl": "<string>",
            "sourceReason": "<string>",
            "listingStart": "<string>",
            "listingEnd": "<string>",
            "imageUrl": "<string>",
            "referenceDocs": [
              {
                "url": "<string>",
                "description": "<string>"
              }
            ],
            "additionalData": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ]
          }
        ],
        "mediaData": [
          {
            "title": "<string>",
            "source": "<string>",
            "snippet": "<string>",
            "sourceDate": "<string>",
            "sourceCountry": "<string>",
            "url": "<string>",
            "isCurrent": true
          }
        ]
      },
      "errors": [
        {
          "code": "<string>",
          "description": "<string>",
          "location": "<string>"
        }
      ],
      "notes": {},
      "systemStatus": "VALID",
      "riskFactors": [
        {
          "factor": "<string>",
          "value": "<string>"
        }
      ],
      "updatedBy": "<string>"
    }
  ]
}

Authorizations

​
api_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
X-Frankie-Channel
string

Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

​
X-Frankie-Username
string

Username provided by API caller

Example:

"fred.flintstone@frankieone.com"

Path Parameters

​
entityId
string
required

Unique FrankieOne identifier for an entity

Body

application/json
​
processResults
string<UUID>[]
​
manualStatus
enum<string>

Any manual status set after the results have been reviewed.

  • CLEAR: When the result is determined to be clear and no further action is needed.
  • REJECTED: When the result is determined to be rejected and no further action is needed.
Available options:
CLEAR,
REJECTED
​
comment
object

Response

OK

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
processResults
object[]