Cloud API

Update an identity by ID

PATCH https://api.imageintelligence.com/v2/recognition/identities/{namespace}/{id}

PATCH /identities/{namespace}/{id} provides the ability to update an identity's attributes as well as add/remove imageIds associated to an identity.

It's important to mention if you remove all imageIds associated with an identity, the identity won't be removed. If the goal is to remove the identity entirely, you can DELETE /identities/{namespace}/{id}.

Request Parameters

NameInDescription
namespace
required		pathstring
id
required		pathstring

The ID of a recognition identity

customId
optional		bodystring

An arbitrary client specific resource identifier to reference this job (usually UUID)

images
optional		bodyobject
add
required		array[string]

Max Length: 20, Unique Items: true

Images to add

remove
required		array[string]

Max Length: 20, Unique Items: true

Images to remove

Request Sample

{
  "customId": "0285a6b8-a617-11e6-8253-175f847ef3cf",
  "images": {
    "add": [
      "af278ded-5412-4916-bb5c-13769bfb7644",
      "633081ed-4c05-459b-bddc-061c66581f92",
      "c3c61384-1861-4026-be2e-4d70646231c0"
    ],
    "remove": [
      "57ff6229-9082-4e14-aff6-4244e9dad9eb",
      "9521422c-76d0-4f38-aa10-1c12d11b93f5"
    ]
  }
}

Response Parameters

Recognition update identity request was successfully submitted

id
required		string
customId
optional		string
images
required		array[object]
id
optional		string

ID of the image

customId
optional		string

An arbitrary client specific resource identifier to reference this image (usually UUID)

feedId
optional		string

User specified ID to reference the source of the images within this job

identityId
optional		string

Identity ID associated to this resource

url
optional		string

URL of the image

boundingBox
optional		object

Bounding box values

xMin
required		number

Format: int32

yMin
required		number

Format: int32

xMax
required		number

Format: int32

yMax
required		number

Format: int32

boundingBoxConfidence
optional		number

Confidence level of the resulting bounding box

type
optional		string

Type of response e.g. "FACE"

Possible values: FACE

groupId
optional		string

Group that the resource belongs to

isFrontal
optional		boolean

Whether the image is frontal or not

sharpness
optional		number

Sharpness of the image

width
optional		number

Width of the image

height
optional		number

Height of the image

createdAt
optional		number

Timestamp of when the job was created

namespace
optional		string

Max Length: 128

createdAt
required		integer

UNIX timestamp for when the identity was created

Format: int64

Response Sample

{
  "id": "ab36de62-fe3e-4907-8a03-7d27c21fa01a",
  "customId": "0285a6b8-a617-11e6-8253-175f847ef3cf",
  "images": [
    {
      "id": "52547074-a622-11e6-8f61-63f37dc33285",
      "customId": "some_person_filled_image",
      "feedId": "Camera_123456",
      "identityId": "af278ded-5412-4916-bc5c-13469bfe7644",
      "url": "https://publicly.available.domain.net/image-001.jpg",
      "boundingBox": {
        "xMin": 0.23873,
        "yMin": 0.23873,
        "xMax": 0.75087,
        "yMax": 0.96537
      },
      "groupId": "63652986-b730-4ab8-a175-7914a950e7a0",
      "boundingBoxConfidence": 0.9129213,
      "type": "FACE",
      "isFrontal": true,
      "sharpness": 0.671230746,
      "width": 150,
      "height": 200,
      "createdAt": 1487648348000
    }
  ],
  "namespace": "acme",
  "createdAt": 1487648348000
}