V2VtFlowRecordDto

idstringrequired

Identifier of the flow record.

participantSessionIdstringrequired

DIDComm session identifier of the flow.

flowStatestringrequired

Current Flow State.

Possible values: [AWAITING_OP, OR_SENT, AWAITING_OR, IR_SENT, AWAITING_IR, OOB_PENDING, VALIDATING, AWAITING_VALIDATION_TX, VALIDATION_TX_SUBMITTED, VALIDATION_TX_FAILED, VALIDATED, VALIDATED_PENDING_CLAIMS, CRED_OFFERED, COMPLETED, CRED_REVOKED, TERMINATED_BY_VALIDATOR, TERMINATED_BY_APPLICANT, ERROR, PARTICIPANT_REVOKED, PARTICIPANT_SLASHED]

connectionStatestringrequired

Current Connection State.

Possible values: [NOT_CONNECTED, ESTABLISHED, TERMINATED]

rolestringrequired

Role of the agent in the flow.

Possible values: [applicant, validator]

variantstringrequired

Flow variant that the agent runs.

Possible values: [onboarding-process, direct-issuance]

threadIdstringrequired

DIDComm thread identifier of the flow.

connectionIdstringrequired

Identifier of the DIDComm connection of the flow.

agentParticipantIdstringrequired

Participant identifier of this agent.

walletAgentParticipantIdstringrequired

Participant identifier of the wallet agent of this agent.

peerDidstring

DID of the remote peer.

applicantParticipantIdstring

Participant identifier of the applicant entry being onboarded.

validatorParticipantIdstring

Participant identifier of the validator entry the applicant is onboarding under.

schemaIdstring

Credential schema identifier of the flow.

claimsobject

Credential claims that the applicant submitted.

proofsobject[]

Proofs that the applicant submitted.

oobLink object

The outstanding oob-link, when one exists. Cleared on every transition out of OOB_PENDING. An expired link stays on the record until then and pendingAction reports it.

urlstringrequired

descriptionstringrequired

expiresAtstring

expires_time of the message, when the sender set one.

atstringrequired

When the agent sent or received the message.

messages object[]required

Human-readable messages of the flow, in order. A validator lists what it sent, an applicant what it received.

Array [

typestringrequired

Possible values: [oob-link, validating, problem-report]

textstring

Absent for a validating sent without a comment.

atstringrequired

urlstring

Set for an oob-link only.

]

pendingActionstringrequired

The party that must act for the flow to progress.

Possible values: [APPLICANT, VALIDATOR, AGENT, CHAIN, NONE]

validation object

Validation decision of an Onboarding Process flow, set by validateFlow.

decidedAtstringrequired

submissionstringrequired

Possible values: [AGENT, OPERATOR]

validationFeesnumber

issuanceFeesnumber

verificationFeesnumber

issuanceFeeDiscountnumber

Decimal between 0 and 1.

verificationFeeDiscountnumber

Decimal between 0 and 1.

effectiveUntilstring

opSummaryDigeststring

tx object

hashstring

submittedAtstring

heightnumber

statusstringrequired

Possible values: [SUBMITTED, SUCCEEDED, FAILED]

reasonstring

Set when the transaction failed.

errorstring

Raw node or chain message.

issuance object

Outcome of the transaction that anchors the issued credential.

tx object

hashstring

submittedAtstring

heightnumber

statusstringrequired

Possible values: [SUBMITTED, SUCCEEDED, FAILED]

reasonstring

Set when the transaction failed.

errorstring

Raw node or chain message.

credentialExchangeRecordIdstring

Identifier of the credential exchange of the offered credential.

credentialIdstring

Identifier of the offered credential.

credentialDigeststring

digestJCS of the offered credential.

subprotocolThidstring

DIDComm thread identifier of the subprotocol in flight.

errorMessagestring

Message of the error that stopped the flow.

createdAtstring<date-time>required

Time when the agent created the flow.

updatedAtstring<date-time>required

Time when the agent last changed the flow.

lastEventAtstring<date-time>required

Time of the last event of the flow.

V2VtFlowRecordDto

{
  "id": "string",
  "participantSessionId": "string",
  "flowState": "AWAITING_OP",
  "connectionState": "NOT_CONNECTED",
  "role": "applicant",
  "variant": "onboarding-process",
  "threadId": "string",
  "connectionId": "string",
  "agentParticipantId": "string",
  "walletAgentParticipantId": "string",
  "peerDid": "string",
  "applicantParticipantId": "string",
  "validatorParticipantId": "string",
  "schemaId": "string",
  "claims": {},
  "proofs": [
    {}
  ],
  "oobLink": {
    "url": "string",
    "description": "string",
    "expiresAt": "string",
    "at": "string"
  },
  "messages": [
    {
      "type": "oob-link",
      "text": "string",
      "at": "string",
      "url": "string"
    }
  ],
  "pendingAction": "APPLICANT",
  "validation": {
    "decidedAt": "string",
    "submission": "AGENT",
    "validationFees": 0,
    "issuanceFees": 0,
    "verificationFees": 0,
    "issuanceFeeDiscount": 0,
    "verificationFeeDiscount": 0,
    "effectiveUntil": "string",
    "opSummaryDigest": "string",
    "tx": {
      "hash": "string",
      "submittedAt": "string",
      "height": 0,
      "status": "SUBMITTED",
      "reason": "string",
      "error": "string"
    }
  },
  "issuance": {
    "tx": {
      "hash": "string",
      "submittedAt": "string",
      "height": 0,
      "status": "SUBMITTED",
      "reason": "string",
      "error": "string"
    }
  },
  "credentialExchangeRecordId": "string",
  "credentialId": "string",
  "credentialDigest": "string",
  "subprotocolThid": "string",
  "errorMessage": "string",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "lastEventAt": "2024-07-29T15:51:28.071Z"
}