Loading
Documentation Powered by ReDoc

DFS OTP Services API (latest)

Download OpenAPI specification:Download

Contains functionality around OTP (one time password) services.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

ContactVerification

Check validity of a one-time verification code

Checks validity of a one-time verification code sent to the contact under the context of a specific session.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id

sessionId
required
string

Session id

key
required
string

Key

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/contacts/{contactId}/sessions/{sessionId}/verification-key/{key}/check
https://example-host/v1.0/contacts/{contactId}/sessions/{sessionId}/verification-key/{key}/check

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "keyStatus": "Valid",
  • "attemptsLeft": 0
}

Verify a one-time verification code

Verifies a one-time verification code sent to the contact under the context of a specific session.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id

sessionId
required
string

Session id

key
required
string

Key

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/contacts/{contactId}/sessions/{sessionId}/verification-key/{key}/verify
https://example-host/v1.0/contacts/{contactId}/sessions/{sessionId}/verification-key/{key}/verify

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "keyStatus": "Valid",
  • "attemptsLeft": 0
}

Send a one-time verification code

Sends a one-time verification code to the contact in a specific channel. If a sessionId is not specified, a generated sessionId would be returned (to be used when verifying the key).

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact ID.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Send verification key request.

sessionId
string Nullable
channel
string (VerificationChannelKey)
Enum: "Sms" "Email"
templateMetadataKey
string Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/contacts/{contactId}/verification-key/send
https://example-host/v1.0/contacts/{contactId}/verification-key/send

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sessionId": "string",
  • "channel": "Sms",
  • "templateMetadataKey": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "generatedSessionId": "string"
}

Send a one time verification code to a pending communication channel

Sends a one time verification code to a pending communication channel as set in contact details. This endpoint should only be used internally when orchestrating communication channel update using OTP.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact ID.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Send verification key request.

sessionId
string Nullable
channel
string (Api.ContactVerifications.SendVerificationKeyPendingCommunicationChannels.VerificationChannelKey)
Enum: "Sms" "Email"

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/contacts/{contactId}/pending-communication-channels/verification-key/send
https://example-host/v1.0/contacts/{contactId}/pending-communication-channels/verification-key/send

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sessionId": "string",
  • "channel": "Sms"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}