Sign in

v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Flow

Create a new customer for Flow workflows

Creates a new customer profile within a Flow workflow context. Customer PII is encrypted before storage and returned without PII by default. This endpoint checks for existing customers to prevent duplicates.

IVMS101 Validation Requirements:

  • For natural persons: name object is required
  • For legal persons: name and nationalIdentification objects are required
  • When nameIdentifier array is provided, its fields are required
  • Unknown fields are rejected (strict validation)
post/entities/{entityDID}/flow/customers

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

Request body

customerDidstring required

Customer identifier (mailto:, tel:, or did:web/did:ethr/did:pkh/did:key/did:jwk/did:keri). When a DID is used, profileData.contactInformation.email is required for OTP.

customerType'natural_person' | 'legal_person' required

Type of customer (natural person or legal entity)

verificationStatus'pending' | 'verified' | 'rejected' | 'expired'
verificationLevel'basic' | 'enhanced' | 'premium'

Response

Customer created successfully

customerDidstring

Customer DID identifier

entityDidstring

Entity DID that owns this customer

customerType'natural_person' | 'legal_person'

Type of customer

profileDataobject

Encrypted IVMS101 customer profile data (PII encrypted)

verificationStatus'pending' | 'verified' | 'rejected' | 'expired'

Customer verification status

verificationLevel'basic' | 'enhanced' | 'premium'

Level of verification performed

verifiedAtstring date-time

When verification was completed

verificationExpiresAtstring date-time

When verification expires

createdAtstring date-time

Customer creation timestamp

updatedAtstring date-time

Customer last update timestamp