Files
sxchnge/backend/contracts/sendico/api/verification/request/verification.yaml
T

74 lines
2.0 KiB
YAML

components:
schemas:
VerificationCodeRequest:
type: object
additionalProperties: false
required:
- purpose
properties:
purpose:
type: string
description: Verification purpose, e.g. login.
target:
type: string
format: email
description: Optional destination override. When omitted, current handler falls back to the authenticated account email/login.
idempotencyKey:
type: string
quoteRef:
description: Required when `purpose` is `payout`; omitted for login and other verification purposes.
type: string
allOf:
- if:
properties:
purpose:
const: payout
required:
- purpose
then:
required:
- quoteRef
CodeVerificationRequest:
type: object
additionalProperties: false
required:
- purpose
- code
properties:
purpose:
type: string
description: Verification purpose, e.g. login.
target:
type: string
format: email
description: Optional destination override. When omitted, current handler falls back to the authenticated account email/login.
idempotencyKey:
type: string
quoteRef:
description: Required when `purpose` is `payout`; omitted for login and other verification purposes.
type: string
code:
type: string
sessionIdentifier:
$ref: ../../../models/auth/session_identifier.yaml#/components/schemas/SessionIdentifier
allOf:
- if:
properties:
purpose:
const: login
required:
- purpose
then:
required:
- sessionIdentifier
- if:
properties:
purpose:
const: payout
required:
- purpose
then:
required:
- quoteRef