Skip to main content
PATCH
/
v2
/
organizations
/
{entityId}
/
documents
/
{documentId}
Update a single document by its id.
curl --request PATCH \
  --url https://api.uat.frankie.one/v2/organizations/{entityId}/documents/{documentId} \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "comment": {
    "text": "Update after speaking to customer over the phone directly.",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}
'
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "document": {
    "country": "AUS",
    "class": "IDENTITY",
    "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "expiryDate": {
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "type": "GREGORIAN",
      "normalized": "1990-03-31"
    },
    "issueDate": {
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "type": "GREGORIAN",
      "normalized": "1990-03-31"
    },
    "primaryIdentifier": "000734130",
    "secondaryIdentifier": "P0001975",
    "subtype": "Photo Comparison",
    "subdivision": "VIC",
    "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",
      "type": "GREGORIAN",
      "normalized": "1990-03-31"
    },
    "validTo": {
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "type": "GREGORIAN",
      "normalized": "1990-03-31"
    },
    "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
    "supplementaryData": {
      "reference": "1",
      "nameOnCardLine1": "<string>",
      "nameOnCardLine2": "<string>",
      "nameOnCardLine3": "<string>",
      "nameOnCardLine4": "<string>",
      "middleNameOnCard": "<string>"
    },
    "customAttributes": {},
    "attachments": [
      {
        "data": {
          "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
        },
        "attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sourceId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "filename": "<string>",
        "mimeType": "<string>",
        "pageNumber": 123,
        "type": "<string>",
        "location": "<string>",
        "lastMalwareScanAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

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

​
documentId
string
required

Unique identifier for a document

Query Parameters

​
level
enum<string>
default:meta

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
Available options:
meta,
base64

Body

application/json
​
document
object
​
comment
object

Response

OK

​
requestId
string
required

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
entityId
string
read-only

Entities are assigned a FrankieOne 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.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
document
object