---
updatedAt: 2025-11-11T23:14:56.000Z
agentTools:
projectIndex: https://developers.fortresstrust.com/llms.txt
---
# Update existing personal identity (Auth)
Used for updating an L0 identity to L1
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Fortress.Identity Api",
"version": "1.0"
},
"servers": [
{
"url": "https://api.sandbox.fortressapi.com/"
}
],
"paths": {
"/api/compliance/v1/personal-identities/{identityId}": {
"patch": {
"tags": [
"PersonalIdentities"
],
"summary": "Update existing personal identity (Auth)",
"parameters": [
{
"name": "identityId",
"in": "path",
"description": "Identity id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonalUserIdentityUpdateModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PersonalUserIdentityUpdateModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PersonalUserIdentityUpdateModel"
}
}
}
},
"responses": {
"200": {
"description": "Identity was successfully updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonalUserIdentityModel"
}
}
}
},
"400": {
"description": "Bad request model data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Identity with such auth identifier is not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Identity has no access to a specified identity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Identity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
}
},
"components": {
"schemas": {
"AddressModel": {
"required": [
"city",
"country",
"street1"
],
"type": "object",
"properties": {
"street1": {
"minLength": 1,
"type": "string",
"description": "Gets or sets the first street"
},
"street2": {
"type": "string",
"description": "Gets or sets the second street",
"nullable": true
},
"postalCode": {
"type": "string",
"description": "Gets or sets the postal code (ZIP code)",
"nullable": true
},
"city": {
"minLength": 1,
"type": "string",
"description": "Gets or sets the city"
},
"state": {
"type": "string",
"description": "Gets or sets the state",
"nullable": true
},
"country": {
"minLength": 1,
"type": "string",
"description": "Gets or sets the country"
}
},
"additionalProperties": false,
"description": "Represents Address model"
},
"BusinessDocumentType": {
"enum": [
"other",
"proofOfAddress",
"proofOfCompanyFormation",
"formationDocument",
"agreement",
"taxIdDocument"
],
"type": "string"
},
"DocumentModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"identityId": {
"type": "string",
"format": "uuid"
},
"personalDocumentType": {
"$ref": "#/components/schemas/PersonalDocumentType"
},
"businessDocumentType": {
"$ref": "#/components/schemas/BusinessDocumentType"
},
"documentReferenceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"documentUuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"documentCheckStatus": {
"$ref": "#/components/schemas/DocumentStatus"
},
"isVerified": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"DocumentStatus": {
"enum": [
"pending",
"automaticReviewInProgress",
"manualReviewNeeded",
"accepted",
"rejected",
"resubmit"
],
"type": "string"
},
"DueDiligenceModel": {
"type": "object",
"properties": {
"employmentStatus": {
"$ref": "#/components/schemas/EmploymentStatus"
},
"industry": {
"$ref": "#/components/schemas/Industry"
},
"occupation": {
"$ref": "#/components/schemas/Occupation"
},
"occupationDescription": {
"type": "string",
"nullable": true
},
"incomeSource": {
"$ref": "#/components/schemas/IncomeSource"
},
"incomeState": {
"type": "string",
"nullable": true
},
"incomeCountryCode": {
"type": "string",
"nullable": true
},
"employer": {
"type": "string",
"nullable": true
},
"employerState": {
"type": "string",
"nullable": true
},
"employerCountryCode": {
"type": "string",
"nullable": true
},
"wealthSource": {
"$ref": "#/components/schemas/WealthSource"
},
"wealthSourceDescription": {
"type": "string",
"nullable": true
},
"sourceOfFunds": {
"$ref": "#/components/schemas/SourceOfFunds"
},
"annualIncome": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"EmploymentStatus": {
"enum": [
"employed",
"selfEmployed",
"retired",
"unemployed",
"student"
],
"type": "string"
},
"IncomeSource": {
"enum": [
"salary",
"selfEmployed",
"inheritance",
"investments",
"retirement",
"rentalIncome",
"governmentBenefits",
"familySupport"
],
"type": "string"
},
"Industry": {
"enum": [
"agriculture",
"mining",
"utilities",
"construction",
"manufacturing",
"chemicalManufacturing",
"merchantWholesale",
"automotive",
"retailFurnishing",
"retailElectronics",
"retailHome",
"retailFood",
"healthStores",
"gasoline",
"retailClothing",
"retailSporting",
"retailNonStore",
"transportation",
"publishing",
"finance",
"realEstate",
"rentalServices",
"professionalNonLegal",
"accounting",
"travel",
"educationalMedical",
"performingArts",
"recreationGambling",
"foodService",
"maintenance",
"laundry",
"religiousCharity",
"publicAdministration"
],
"type": "string"
},
"Occupation": {
"enum": [
"executive",
"sales",
"consulting",
"government",
"healthcare",
"financeAccounting",
"technology",
"scienceEngineering",
"foodServices",
"legalServices",
"manufacturing",
"other"
],
"type": "string"
},
"PersonalDocumentType": {
"enum": [
"license",
"identificationCard",
"passport"
],
"type": "string"
},
"PersonalUserIdentityModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"identityContainerId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"kycLevel": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/UserIdentityType"
},
"status": {
"$ref": "#/components/schemas/UserIdentityStatus"
},
"address": {
"$ref": "#/components/schemas/AddressModel"
},
"email": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentModel"
},
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"middleName": {
"type": "string",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"format": "date",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"ssn": {
"type": "string",
"nullable": true
},
"isSuspended": {
"type": "boolean"
},
"upgradeRequirements": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"dueDiligence": {
"$ref": "#/components/schemas/DueDiligenceModel"
},
"fullName": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"PersonalUserIdentityUpdateModel": {
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/AddressModel"
},
"dateOfBirth": {
"type": "string",
"description": "Gets or sets the Date of Birth",
"format": "date",
"nullable": true
},
"ssn": {
"type": "string",
"description": "Gets or sets SSN",
"nullable": true
},
"email": {
"type": "string",
"description": "Get or set email",
"nullable": true
},
"phone": {
"type": "string",
"description": "Get or set phone",
"nullable": true
},
"firstName": {
"type": "string",
"description": "Get or set first name",
"nullable": true
},
"lastName": {
"type": "string",
"description": "Get or set last name",
"nullable": true
},
"middleName": {
"type": "string",
"description": "Get or set middle name",
"nullable": true
},
"upgradeKYC": {
"type": "boolean",
"description": "Indicate whether we need to run KYC upgrade process"
},
"dueDiligence": {
"$ref": "#/components/schemas/DueDiligenceModel"
}
},
"additionalProperties": false,
"description": "Represents personal user identity update model"
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": {}
},
"SourceOfFunds": {
"enum": [
"selfEmployed",
"generalEmployee",
"seniorExecutive",
"retired",
"homemaker",
"inheritanceGift",
"investment",
"salary",
"businessOwner",
"alimony",
"retirement",
"lottery",
"annuity",
"trustIncome",
"realEstate",
"governmentBenefits",
"legalSettlement"
],
"type": "string"
},
"UserIdentityStatus": {
"enum": [
"active",
"inactive",
"inactivationStarted"
],
"type": "string"
},
"UserIdentityType": {
"enum": [
"personal",
"business"
],
"type": "string"
},
"WealthSource": {
"enum": [
"salary",
"selfEmployed",
"inheritance",
"familySupport",
"investments",
"retirement",
"rentalIncome",
"governmentBenefits",
"businessSale",
"other"
],
"type": "string"
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Put access token in the box below.
For example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6I",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": []
}
],
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```