---
title: "addEmbeddedPerson"
method: POST
path: "/api/customers/{customerId}/persons"
tags: ["customer-controller"]
---

# addEmbeddedPerson

`POST /api/customers/{customerId}/persons`

## Path parameters

- `customerId` string, required

## Query parameters

- `tokenValue` string

## Headers

- `accept-language` string

## Request body

- PersonReq
  - `aliases` object
  - `archivedDtm` TimestampReq
    - `date` integer
    - `hours` integer
    - `minutes` integer
    - `month` integer
    - `nanos` integer
    - `seconds` integer
    - `time` integer
    - `year` integer
  - `createdDtm` TimestampReq
    - `date` integer
    - `hours` integer
    - `minutes` integer
    - `month` integer
    - `nanos` integer
    - `seconds` integer
    - `time` integer
    - `year` integer
  - `email` string
  - `expiringDtm` string
  - `extendedAttributes` object
  - `firstName` string
  - `id` string
  - `idxId` string
  - `idxInstanceId` string
  - `idxTenant` string
  - `idxUserId` string
  - `info` PersonInfoReq
    - `approvals` ApprovalReq[]
      - `createdDtm` TimestampReq
        - `date` integer
        - `hours` integer
        - `minutes` integer
        - `month` integer
        - `nanos` integer
        - `seconds` integer
        - `time` integer
        - `year` integer
      - `id` string
      - `provider` string
      - `url` string
    - `approvalsNotifiedAbout` ApprovalNotifiedAboutReq[]
      - `emailDateTime` TimestampReq
        - `date` integer
        - `hours` integer
        - `minutes` integer
        - `month` integer
        - `nanos` integer
        - `seconds` integer
        - `time` integer
        - `year` integer
      - `errorInfo` string
      - `url` string
    - `attributePermissions` AttributePermissionReq[]
      - `createdDtm` TimestampReq
        - `date` integer
        - `hours` integer
        - `minutes` integer
        - `month` integer
        - `nanos` integer
        - `seconds` integer
        - `time` integer
        - `year` integer
      - `decision` 'ALWAYS' | 'JUST_ONCE' | 'NEVER'
      - `providerId` string
      - `providerType` 'CREDENTIAL_PROVIDER' | 'SERVICE_PROVIDER'
      - `requestedAttributeType` 'ANONYMOUS' | 'EMAIL' | 'ID_TOKEN' | 'NAME' | 'PHOTO' | 'SYSTEM_ID'
      - `updatedDtm` TimestampReq
        - `date` integer
        - `hours` integer
        - `minutes` integer
        - `month` integer
        - `nanos` integer
        - `seconds` integer
        - `time` integer
        - `year` integer
    - `credentialTypePermissions` CredentialTypePermissionReq[]
      - `createdDtm` TimestampReq
        - `date` integer
        - `hours` integer
        - `minutes` integer
        - `month` integer
        - `nanos` integer
        - `seconds` integer
        - `time` integer
        - `year` integer
      - `credentialTypeHref` string
      - `decision` 'ALWAYS' | 'JUST_ONCE' | 'NEVER'
      - `providerId` string
      - `providerType` 'CREDENTIAL_PROVIDER' | 'SERVICE_PROVIDER'
      - `updatedDtm` TimestampReq
        - `date` integer
        - `hours` integer
        - `minutes` integer
        - `month` integer
        - `nanos` integer
        - `seconds` integer
        - `time` integer
        - `year` integer
    - `notificationEmailValidated` boolean
    - `registeredApiMap` object
    - `tags` Tag[]
      - `id` string
      - `value` string
  - `initialFields` PersonReq — recursive
  - `lastName` string
  - `lastUpdatedDtm` TimestampReq
    - `date` integer
    - `hours` integer
    - `minutes` integer
    - `month` integer
    - `nanos` integer
    - `seconds` integer
    - `time` integer
    - `year` integer
  - `lastUsedDtm` TimestampReq
    - `date` integer
    - `hours` integer
    - `minutes` integer
    - `month` integer
    - `nanos` integer
    - `seconds` integer
    - `time` integer
    - `year` integer
  - `locks` LockInfoReq[]
    - `attemptsMade` integer
    - `attemptsRemaining` integer
    - `lockedUntil` TimestampReq
      - `date` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `year` integer
    - `subType` string
    - `type` string
  - `permittedOperations` string[]
  - `publicAliasesFor` ServiceProviderReq
    - `archivedDtm` TimestampReq
      - `date` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `year` integer
    - `areasOfBusiness` AreasOfBusiness
      - `areas` string[]
    - `createdDtm` TimestampReq
      - `date` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `year` integer
    - `credTypesOfInterest` CredentialTypeOfInterest[]
      - `credentialTypeHrefRegEx` string
      - `eventTypes` string[]
    - `description` string
    - `i18nInfo` object
    - `icon` string, byte
    - `id` string
    - `lastUpdatedBy` string
    - `lastUpdatedDtm` TimestampReq
      - `date` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `year` integer
    - `name` string
    - `notificationEmail` string
    - `permittedOperations` string[]
    - `status` 'ACTIVE' | 'ARCHIVED' | 'BLOCKED' | 'PENDING'
    - `visibility` 'PRIVATE' | 'PUBLIC' | 'RESTRICTED'
  - `region` RegionReq
    - `approvals` object
    - `createdDtm` TimestampReq
      - `date` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `year` integer
    - `description` string
    - `id` string
    - `locales` string[]
    - `name` string
    - `permittedOperations` string[]
    - `status` 'ACTIVE' | 'ARCHIVED' | 'PENDING'
  - `sessionInfo` SessionInfo
    - `bearerToken` string
    - `invitationCode` string
    - `regChallenges` RegChallenge[]
      - `fidoRegRequest` string
      - `fidoRegResponse` string
      - `fidoResponseCode` integer
      - `fidoResponseMessage` string
      - `id` string
      - `status` 'ERROR' | 'FAILED' | 'PENDING' | 'SUCCESS'
  - `status` 'ACTIVE' | 'ARCHIVED' | 'BLOCKED' | 'PENDING' | 'REREG_CONFIRMED'
  - `tenant` TenantReq
    - `archivedDtm` TimestampReq
      - `date` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `year` integer
    - `createdDtm` TimestampReq
      - `date` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `year` integer
    - `id` string
    - `idTokenInfo` IdTokenInfo
      - `audience` string
      - `issuer` string
      - `timeToLive` integer
    - `lastUpdatedDtm` TimestampReq
      - `date` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `year` integer
    - `name` string
    - `notificationEmail` string
    - `permittedOperations` string[]
    - `status` 'ACTIVE' | 'ARCHIVED' | 'BLOCKED' | 'PENDING'

## Response `201`

Created

- PersonRes
  - `aliases` object
  - `archivedDtm` TimestampRes
    - `date` integer
    - `day` integer
    - `hours` integer
    - `minutes` integer
    - `month` integer
    - `nanos` integer
    - `seconds` integer
    - `time` integer
    - `timezoneOffset` integer
    - `year` integer
  - `createdDtm` TimestampRes
    - `date` integer
    - `day` integer
    - `hours` integer
    - `minutes` integer
    - `month` integer
    - `nanos` integer
    - `seconds` integer
    - `time` integer
    - `timezoneOffset` integer
    - `year` integer
  - `email` string
  - `expiringDtm` string
  - `extendedAttributes` object
  - `firstName` string
  - `href` string
  - `id` string
  - `idxId` string
  - `idxInstanceId` string
  - `idxTenant` string
  - `idxUserId` string
  - `info` PersonInfoRes
    - `approvals` ApprovalRes[]
      - `createdDtm` TimestampRes
        - `date` integer
        - `day` integer
        - `hours` integer
        - `minutes` integer
        - `month` integer
        - `nanos` integer
        - `seconds` integer
        - `time` integer
        - `timezoneOffset` integer
        - `year` integer
      - `id` string
      - `provider` string
      - `url` string
    - `approvalsNotifiedAbout` ApprovalNotifiedAboutRes[]
      - `emailDateTime` TimestampRes
        - `date` integer
        - `day` integer
        - `hours` integer
        - `minutes` integer
        - `month` integer
        - `nanos` integer
        - `seconds` integer
        - `time` integer
        - `timezoneOffset` integer
        - `year` integer
      - `errorInfo` string
      - `url` string
    - `attributePermissions` AttributePermissionRes[]
      - `createdDtm` TimestampRes
        - `date` integer
        - `day` integer
        - `hours` integer
        - `minutes` integer
        - `month` integer
        - `nanos` integer
        - `seconds` integer
        - `time` integer
        - `timezoneOffset` integer
        - `year` integer
      - `decision` 'ALWAYS' | 'JUST_ONCE' | 'NEVER'
      - `providerId` string
      - `providerType` 'CREDENTIAL_PROVIDER' | 'SERVICE_PROVIDER'
      - `requestedAttributeType` 'ANONYMOUS' | 'EMAIL' | 'ID_TOKEN' | 'NAME' | 'PHOTO' | 'SYSTEM_ID'
      - `updatedDtm` TimestampRes
        - `date` integer
        - `day` integer
        - `hours` integer
        - `minutes` integer
        - `month` integer
        - `nanos` integer
        - `seconds` integer
        - `time` integer
        - `timezoneOffset` integer
        - `year` integer
    - `credentialTypePermissions` CredentialTypePermissionRes[]
      - `createdDtm` TimestampRes
        - `date` integer
        - `day` integer
        - `hours` integer
        - `minutes` integer
        - `month` integer
        - `nanos` integer
        - `seconds` integer
        - `time` integer
        - `timezoneOffset` integer
        - `year` integer
      - `credentialTypeHref` string
      - `decision` 'ALWAYS' | 'JUST_ONCE' | 'NEVER'
      - `providerId` string
      - `providerType` 'CREDENTIAL_PROVIDER' | 'SERVICE_PROVIDER'
      - `updatedDtm` TimestampRes
        - `date` integer
        - `day` integer
        - `hours` integer
        - `minutes` integer
        - `month` integer
        - `nanos` integer
        - `seconds` integer
        - `time` integer
        - `timezoneOffset` integer
        - `year` integer
    - `notificationEmailValidated` boolean
    - `registeredApiMap` object
    - `tags` Tag[]
      - `id` string
      - `value` string
  - `lastName` string
  - `lastUpdatedDtm` TimestampRes
    - `date` integer
    - `day` integer
    - `hours` integer
    - `minutes` integer
    - `month` integer
    - `nanos` integer
    - `seconds` integer
    - `time` integer
    - `timezoneOffset` integer
    - `year` integer
  - `lastUsedDtm` TimestampRes
    - `date` integer
    - `day` integer
    - `hours` integer
    - `minutes` integer
    - `month` integer
    - `nanos` integer
    - `seconds` integer
    - `time` integer
    - `timezoneOffset` integer
    - `year` integer
  - `locks` LockInfoRes[]
    - `attemptsMade` integer
    - `attemptsRemaining` integer
    - `lockedUntil` TimestampRes
      - `date` integer
      - `day` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `timezoneOffset` integer
      - `year` integer
    - `subType` string
    - `type` string
  - `permittedOperations` string[]
  - `region` RegionRes
    - `approvals` object
    - `createdDtm` TimestampRes
      - `date` integer
      - `day` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `timezoneOffset` integer
      - `year` integer
    - `description` string
    - `href` string
    - `id` string
    - `locales` string[]
    - `name` string
    - `permittedOperations` string[]
    - `status` 'ACTIVE' | 'ARCHIVED' | 'PENDING'
  - `sessionInfo` SessionInfo
    - `bearerToken` string
    - `invitationCode` string
    - `regChallenges` RegChallenge[]
      - `fidoRegRequest` string
      - `fidoRegResponse` string
      - `fidoResponseCode` integer
      - `fidoResponseMessage` string
      - `id` string
      - `status` 'ERROR' | 'FAILED' | 'PENDING' | 'SUCCESS'
  - `status` 'ACTIVE' | 'ARCHIVED' | 'BLOCKED' | 'PENDING' | 'REREG_CONFIRMED'
  - `tenant` TenantRes
    - `archivedDtm` TimestampRes
      - `date` integer
      - `day` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `timezoneOffset` integer
      - `year` integer
    - `createdDtm` TimestampRes
      - `date` integer
      - `day` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `timezoneOffset` integer
      - `year` integer
    - `href` string
    - `id` string
    - `idTokenInfo` IdTokenInfo
      - `audience` string
      - `issuer` string
      - `timeToLive` integer
    - `lastUpdatedDtm` TimestampRes
      - `date` integer
      - `day` integer
      - `hours` integer
      - `minutes` integer
      - `month` integer
      - `nanos` integer
      - `seconds` integer
      - `time` integer
      - `timezoneOffset` integer
      - `year` integer
    - `name` string
    - `notificationEmail` string
    - `permittedOperations` string[]
    - `status` 'ACTIVE' | 'ARCHIVED' | 'BLOCKED' | 'PENDING'

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.dev/myverifly/apis/api-documentation.md) · [All operations](https://skmtc.dev/myverifly/apis/api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/myverifly/api-documentation/revisions/03f300608c33/schema)