Flow

Get a customer profile by DID

Retrieves a customer profile within a Flow workflow context. Customer PII can be optionally included in the response based on the includePII query parameter and user permissions. PII data is decrypted on-demand when requested.

get/entities/{entityDID}/flow/customers/{customerDID}

Request

Base URL
https://api.eu1.notabene.id
Auth
HTTP bearer
TypeScript
https://skmtc.dev/notabene/apis/notabene-api/docs/entities/:entityDID/flow/customers/:customerDID/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

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

The DID of the entity

customerDIDstring required

Customer identifier (mailto:, tel:, or supported DID method)

Query parameters

includePIIstring

Whether to decrypt and include PII data in profileData

Response

Customer profile retrieved successfully

customerDidstring

Customer DID identifier

entityDidstring

Entity DID that owns this customer

customerType'natural_person' | 'legal_person'

Type of customer

profileDataobject

IVMS101 customer profile data. If includePII=false (default), PII is encrypted. If includePII=true, PII is decrypted and returned in plaintext.

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

Changes

No recorded changes to this operation across all 1 revision of this API.