Contract Revisions

Initiate Signature Challenge

Changed on

Initiates a challenge for a specific signature slot of a specific contract revision.

post/api/agreement/v1/contract-revisions/{id}/signatures/{slotCode}/otp-challenges

Request

  • The document declares no server URL.
  • Auth
    OpenID Connect (http://localhost:6999/realms/agate/.well-known/openid-configuration, scopes: agridata.ch.Agridata_Datenbezueger, agridata.ch.Agridata_Datenanbieter)

Path parameters

idstring uuid required
slotCode'DATA_CONSUMER_01' | 'DATA_CONSUMER_02' | 'DATA_PROVIDER_01' | 'DATA_PROVIDER_02' required

Query parameters

actingRole'CONSUMER' | 'PROVIDER'

Selects the role in which the authenticated user acts for this request. Optional: if the authenticated user holds exactly one of the allowed roles, the value is auto-resolved. Returns 400 if the value is unknown, not allowed for this endpoint, or omitted while the user holds multiple matching roles. Returns 403 if the user does not hold the role specified in the parameter.

Response

OK

challengeIdstring uuid
expiresAtstring date-time
maskedPhoneNumberstring

Masked phone number

retryAfterSecondsinteger

Number of remaining attempts

Example response

{
  "expiresAt": "2022-03-10T12:15:50",
  "maskedPhoneNumber": "***********8",
  "retryAfterSeconds": 30
}

Changes

  • 75957f6bdc66Revision changes
    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

  • 1aa7b6ad5bccRevision changes
    • warning

      added the new UID_CLAIM_MISSING enum value to the response property for the response status

    • warning

      added the new UID_CLAIM_MISSING enum value to the response property for the response status