Skip to main content
This page consolidates the foundational fields that appear across multiple Lerian APIs. These fields represent the backbone of how we identify data, track lifecycle events, paginate results, and guarantee traceability.

1. Unique identifiers


FieldDescriptionUsed in
idUniversal unique identifier (UUID v4)Midaz, CRM, Fee, Auth, Flowker, PIX, Identity
accountIdUnique account identifier in the ledgerMidaz, CRM, PIX
organizationIdIdentifier of the owning organizationMidaz, Fee, Flowker
org_idOrganization ID (workflow context)Flowker
ledgerIdUnique ledger identifierMidaz, CRM, Fee
holderIdIdentifier of the account holderCRM
transactionIdUnique financial transaction identifierMidaz, PIX
externalIdCorrelation ID for external systemsCRM, PIX, Flowker
endToEndIdPIX end-to-end identifierPIX
protocolIdDICT PIX protocol identifierPIX
segmentIdOrganizational segment identifierMidaz, Fee
portfolioIdPortfolio identifierMidaz
assetIdFinancial asset identifierMidaz
routeIdOperation route identifierMidaz
templateIdTemplate identifierReporter, Flowker
workflowIdWorkflow identifierFlowker
runIdWorkflow execution identifierFlowker
jobIdProcessing job identifierFlowker, Reporter
tenantIdTenant identifier in multi-tenant systemsFlowker
clientIdOAuth2 client identifierAuth, Flowker
userIdUser identifierAuth, Identity
groupIdGroup identifierIdentity
roleIdRole identifierIdentity
bankIdISPB bank code (8 digits)PIX
providerIdProvider identifier (OAuth2)Flowker
batchIdProcessing batch identifierFlowker
keyIdAPI key identifierFlowker
versionIdVersion identifierFlowker
targetVersionIdTarget version identifier (comparison)Flowker

2. Temporal fields (timestamps)


FieldDescriptionUsed in
createdAtCreation timestamp (ISO 8601)Midaz, CRM, Fee, PIX, Flowker, Identity
updatedAtLast update timestampMidaz, CRM, Fee, PIX, Flowker, Identity
deletedAtLogical deletion timestampMidaz, CRM, Fee, Identity
executedAtEffective execution timestampPIX, Flowker
scheduledAtScheduled execution timePIX, Flowker
expiresAtExpiration timestampPIX, Auth
settledAtFinancial settlement timestampPIX
transactionAtTransaction timestampPIX
dueDateDue datePIX
birthDateDate of birth (YYYY-MM-DD)CRM
foundingDateCompany founding dateCRM
accountOpeningDateAccount opening datePIX
timestampGeneric event timestampAuth, JD Mock, Flowker
uptimeSystem uptimePIX, JD Mock
startDateStart date (RFC3339)Flowker
endDateEnd date (RFC3339)Flowker
startTimeFromWorkflow search start timeFlowker
startTimeToWorkflow search end timeFlowker
lastLoginAtLast login timestampIdentity
lastActivityAtLast activity timestampIdentity

3. Pagination and navigation


FieldDescriptionUsed in
limitItems per page (default: 10)Midaz, CRM, Fee, PIX, Flowker
pageCurrent pageMidaz, CRM, Fee
page_sizePage size (workflow search)Flowker
page_tokenPagination tokenFlowker
offsetPagination offsetFlowker
totalTotal number of itemsMidaz, CRM, Fee
itemsItems in the current pageMidaz, CRM, Fee
sortOrderSort order (asc/desc)CRM
sort_bySort fieldFlowker
sort_orderSort order (asc/desc)Flowker
includeDeletedInclude logically deleted itemsCRM
hardDeletePermanent physical deletionCRM
searchSearch termFlowker

4. Control and audit metadata


FieldDescriptionUsed in
versionResource or API versionPIX, JD Mock, Flowker
environmentEnvironment (prod/dev/stage)PIX, JD Mock
traceIdLog trace identifierPIX, Flowker
correlationIdCross-service correlation IDFlowker
retryCountRetry counterFlowker
maxRetriesMaximum number of retriesFlowker
backoffDelayExponential retry delayFlowker
createdByCreator userIdentity
updatedByLast updater userIdentity
deletedByUser who deleted the resourceIdentity