Sign in

v1

latestOpenAPI 3.0.32026-07-2141248520.9 KB
Individual Documents

Update a single document by it's id.

Update document by id.

patch/v2/individuals/{entityId}/documents/{documentId}

Query parameters

level'meta' | 'base64'

Determines what level of detail to return in the response

  • meta: Return all metadata only, no links or base64 data
  • base64: Return all metadata and images as base64

Headers

api_keystring required
Example:245c765b124a098d09ef8765....

Your API key provided by FrankieOne

X-Frankie-CustomerIDstring required
Example:12345678-1234-1234-1234-123456789012

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstring
Example:87654321-4321-4321-4321-210987654321

Your Customer Child ID provided by FrankieOne

X-Frankie-Channelstring

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-Usernamestring
Example:fred.flintstone@frankieone.com

Username provided by API caller

Request body

Example request

{
  "document": {
    "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "expiryDate": {
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "normalized": "1990-03-31"
    },
    "issueDate": {
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "normalized": "1990-03-31"
    },
    "primaryIdentifier": "000734130",
    "secondaryIdentifier": "P0001975",
    "subtype": "Photo Comparison",
    "subdivision": "VIC",
    "country": "AUS",
    "createdAt": "2024-01-15T02:18:11.365Z",
    "updatedAt": "2025-01-16T02:18:11.365Z",
    "validFrom": {
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "normalized": "1990-03-31"
    },
    "validTo": {
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "normalized": "1990-03-31"
    },
    "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
    "supplementaryData": {
      "reference": "1"
    },
    "attachments": [
      {
        "data": {
          "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
        }
      }
    ]
  },
  "comment": {
    "commentId": "55fc5d54-46f7-49c8-bf78-e07ec79cd6e7",
    "text": "Update after speaking to customer over the phone directly."
  }
}

Response

OK

entitystring

Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request.

requestIdstring required

The unique request identifier for the API call made.

Example response

{
  "entity": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "document": {
    "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "expiryDate": {
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "normalized": "1990-03-31"
    },
    "issueDate": {
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "normalized": "1990-03-31"
    },
    "primaryIdentifier": "000734130",
    "secondaryIdentifier": "P0001975",
    "subtype": "Photo Comparison",
    "subdivision": "VIC",
    "country": "AUS",
    "createdAt": "2024-01-15T02:18:11.365Z",
    "updatedAt": "2025-01-16T02:18:11.365Z",
    "validFrom": {
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "normalized": "1990-03-31"
    },
    "validTo": {
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "normalized": "1990-03-31"
    },
    "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
    "supplementaryData": {
      "reference": "1"
    },
    "attachments": [
      {
        "data": {
          "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
        }
      }
    ]
  },
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}