Skip to main content
PATCH
/
v1
/
profiles
/
{profileId}
Update Profile
curl --request PATCH \
  --url https://clm-svc.gominerva.com/v1/v1/profiles/{profileId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "address1": "123 Main Street",
  "address2": "Apt 4B",
  "addressCity": "Toronto",
  "addressPostalCode": "M5V1C2",
  "addressState": "ON",
  "allowlistUntil": "2024/12/25",
  "archived": false,
  "assignee": "12345-123",
  "country": "Canada",
  "createdBy": "12345-123",
  "dateOfBirth": "1990/01/01",
  "email": "[email protected]",
  "externalId": "123456789",
  "firstName": "John",
  "kind": "individual",
  "lastName": "Smith",
  "middleName": "Michael",
  "monitored": "monitored",
  "name": "John Smith",
  "nationality": "American",
  "occupation": "Software Engineer",
  "organization": "MinervaAI",
  "phone": "+15555555555",
  "sex": "m",
  "status": "pending",
  "updatedBy": "12345-123"
}
'
{
  "msg": "OK",
  "result": {
    "profile": {
      "_v": 1,
      "address1": "1234 Fake St",
      "address2": "Apt 123",
      "addressCity": "Toronto",
      "addressPostalCode": "A1B2C3",
      "addressState": "ON",
      "allowlistUntil": "2024/08/15",
      "archived": false,
      "assignee": "core-user-id",
      "country": "Canada",
      "createdAt": "2024-08-19T18:40:57.656816645Z",
      "createdBy": "core-user-id",
      "dateOfBirth": "YYYY/MM/DD",
      "email": "[email protected]",
      "externalId": "external-customer-id",
      "firstName": "John",
      "flags": [
        {
          "count": 2,
          "kind": "screeningPepMatch"
        }
      ],
      "id": "66c391b92888a0db5cc6d3f6",
      "kind": "individual",
      "lastName": "Smith",
      "lastScreenedTime": "2024-08-15T14:43:02.805Z",
      "monitored": "monitored",
      "nationality": "Canada",
      "occupation": "Minerva",
      "organization": "Software Engineer",
      "phone": "+15555555555",
      "sex": "m",
      "status": "potential_match",
      "tenantId": "ef637217-5fbf-4117-88f0-a9f1246ffe7f",
      "updatedAt": "2024-08-15T14:43:02.805Z"
    }
  },
  "status": 201
}

Authorizations

​
x-api-key
string
header
required

Minerva API key must be provided in the x-api-key header for all API endpoints

Path Parameters

​
profileId
string
required

Profile ID

Body

application/json

Profile update request

​
address1
string

The address line 1 of the known place of residence for the profile. This will be assembled with the address line 2 in the screening input for the "address" value.

Example:

"123 Main Street"

​
address2
string

The address line 2 of the known place of residence for the profile. This will be assembled with the address line 1 in the screening input for the "address" value.

Example:

"Apt 4B"

​
addressCity
string

The city of the known place of residence for the profile. This should be the full city name.

Example:

"Toronto"

​
addressPostalCode
string

The postal code of the known place of residence for the profile.

Example:

"M5V1C2"

​
addressState
string

The ISO-2 code or full state name of the place of residence of the profile.

Example:

"ON"

​
allowlistUntil
string

An optional parameter that indicating that the profile should be created in an allowlisted status. This means that the profile will not generate flags from ongoing monitoring until a certain date in the future, as denoted in "YYYY/MM/DD" format. If this parameter is not provided, then the profile is created in a non-allowlisted state where future screens may generate review tasks.

Example:

"2024/12/25"

​
archived
boolean
Example:

false

​
assignee
string
Example:

"12345-123"

​
country
string

The known country of residence for the profile.

Example:

"Canada"

​
createdBy
string
Example:

"12345-123"

​
dateOfBirth
string

The date of birth of the profile in "YYYY/MM/DD" format.

Example:

"1990/01/01"

​
email
string

The email of the profile. This is not used in screening currently but can be used to store this value in the persistent profile record for cross-referencing purposes.

Example:

"[email protected]"

​
externalId
string

An optional external reference ID that can be supplied in the profile creation, such that it can be more easily cross-referenced with external systems.

Example:

"123456789"

​
firstName
string

The first name of the profile. This will be assembled with the last name in the screening input for the "name" value. Deprecated: Use the Name field instead.

Example:

"John"

​
kind
string

Should be "individual" or "organization". This refers to the entity type in Minerva screening, where an individual is a natural person and an organization is an entity.

Example:

"individual"

​
lastName
string

The last name of the profile. This will be assembled with the first name in the screening input for the "name" value. Deprecated: Use the Name field instead.

Example:

"Smith"

​
middleName
string

The middle name of the profile. This can be optionally provided as a part of the profile name, and will be assembled with the first and last names in the screening input for the "name" value. Deprecated: Use the Name field instead.

Example:

"Michael"

​
monitored
string

Should be "monitored", "not_monitored", or an empty string. If "monitored", then the profile is enrolled in ongoing monitoring where review tasks may be generated for any potential risks found during screening on regular cadences.

Example:

"monitored"

​
name
string

Legacy fields (keeping for backward compatibility)

Example:

"John Smith"

​
nationality
string

The nationality of the profile, being one of the known citizenships of the profile.

Example:

"American"

​
occupation
string

The known occupation or job title of the natural person.

Example:

"Software Engineer"

​
organization
string

The affiliated organization or employer of the natural person.

Example:

"MinervaAI"

​
phone
string

The phone number in e.164 standard format for the profile (+15555555555)

Example:

"+15555555555"

​
sex
string

The known sex of the natural person as reported on an onboarding document. Should be "f" for Female, "m" for Male, "o" for Other, and leave empty for Unknown.

Example:

"m"

​
status
string
Example:

"pending"

​
updatedBy
string
Example:

"12345-123"

Response

201 - application/json

Profile updated successfully

​
msg
string
Example:

"OK"

​
result
object
​
status
integer
Example:

201