EliteID Person API

Overview

The Person endpoint allows you to view and modify person information including photos, signatures, and user-defined field values using GET, POST, and DELETE methods.

See our https://vds.atlassian.net/wiki/spaces/RAP/pages/2295660545 to get access to the API.

1 Overview
2 Get a Person
3 Create a Person
4 Update a Person
5 Update Photo or Signature
6 Delete a Person
7 Field Descriptions

Get a Person

Retrieves person information including photo and user field values.

HTTP Method: GET
URL: /eliteid/externalapi/v1.0/person
Required Parameters: id (guid)

Example Request

GET /eliteid/externalapi/v1.0/person?id=6b3bdc89-79e6-481d-9ba3-2be5c26a660f

Example Response

{
  "Id": "6b3bdc89-79e6-481d-9ba3-2be5c26a660f",
  "IdNumber": "999999",
  "SecondaryId": null,
  "FirstName": "Kevin",
  "MiddleName": "A",
  "LastName": "Jones",
  "FirstNamePreferred": null,
  "PhotoId": null,
  "PhotoUri": null,
  "PhotoTime": null,
  "SignatureId": null,
  "SignatureUri": null,
  "SignatureTime": null,
  "FieldValues": {}
}

Create a Person

Creates a new person record. Omit the id field in the request body.

HTTP Method: POST

Example Request Body

{
  "IdNumber": "999999",
  "FirstName": "Kevin",
  "MiddleName": "A",
  "LastName": "Jones",
  "FieldValues": {
    "735ff460-00e5-4810-b7f4-1125a2418b00": "Student",
  }
}

Example Response

Update a Person

Updates an existing person record. Include the person's id and only the fields you want to modify.

HTTP Method: POST

Example Request Body

Example Response

Update Photo or Signature

Updates a person's photo or signature by providing the image in base64 format.

HTTP Method: POST
Fields:

PhotoAsBase64
SignatureAsBase64

Example Request Body

Example Response

Delete a Person

Delete a person record by specifying a person's id.

HTTP Method: DELETE

Required Parameters: id (guid)

Example Request

Response: HTTP 204

Field Descriptions

The following table describes the fields that may be included in the request and response body. Fields that can be modified using the API are marked Updatable.

Field Name	Description	Updatable

Field Name	Description	Updatable
Id	Unique identifier for the person (UUID format)
IdNumber	Assigned identification number for the person
SecondaryId	Assigned secondary identification number for the person
FirstName	Person's first name
FirstNamePreferred	Person's preferred first name (if different from FirstName)
MiddleName	Person's middle name
LastName	Person's last name
ModifiedTime	Timestamp of the last modification to the person's record
Note	Any additional notes about the person
NoteTime	Timestamp of when the note was last updated
NoteCreatedBy	Identifier of the user who created or last updated the note
SignatureAsBase64	Image in Base64 format
SignatureId	Unique identifier for the person's signature
SignatureTime	Timestamp of when the signature was last updated
SignatureUri	URI to access the person's signature image
PhotoAsBase64	Image in Base64 format
PhotoId	Unique identifier for the person's photo
PhotoTime	Timestamp of when the photo was last updated
PhotoUri	URI to access the person's photo. The link does not expire.
CreationTime	Timestamp of when the person's record was created
LastImportTime	Timestamp of the last time the person's data was bulk imported from an external system
FieldValues	Object containing custom field values, where the key is the field's UUID and the value is the field's content

Notes on FieldValues

The FieldValues object contains custom fields that may vary depending on your specific EliteID configuration.

The exact meaning and use of these custom fields will depend on your organization's setup.