otp-items
Operations addressed under /otp-items — 12 operations.
create-otp-item
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_1 | 400 | OTP_ITEM_MUST_NOT_BE_NULL |
ERR_OTP_11 | 400 | OTP_ITEM_NAME_HAS_ALREADY_BEEN_DEFINED |
create-otp-item › Request Body
keyFormatIdnameretryCountretryDurationvalidityDurationcreate-otp-item › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
idget-otp-item-by-name
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as OtpItemDto.
| Field | Declared type | Nullable |
|---|---|---|
KeyFormatId | Guid | no |
Name | string | no |
ValidityDuration | int? | yes |
RetryDuration | int? | yes |
IsActive | bool | no |
RetryCount | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_14 | 400 | OTP_ITEM_NAME_IS_NOT_FOUND |
path Parameters
nameget-otp-item-by-name › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-otp-validity-by-transaction-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
transactionIdget-otp-validity-by-transaction-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
get-otp-transaction-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<OtpTransactionDto>.
| Field | Declared type | Nullable |
|---|---|---|
OtpItemId | Guid | no |
OneTimePassword | string | no |
EndDate | DateTime? | yes |
StartDate | DateTime? | yes |
RetryDate | DateTime? | yes |
IsConfirmed | bool | no |
PhoneNumber | string | no |
Email | string | no |
KycConfirmed | bool | no |
KycEndDate | DateTime? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-otp-transaction-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
endDateidoneTimePasswordotpItemIdphoneNumberretryDatestartDatecreate-otp-transaction-log
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as OtpLoginFailDto.
| Field | Declared type | Nullable |
|---|---|---|
FailedCount | int? | yes |
IsBlocked | bool | no |
BlockEndDate | DateTime? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_1 | 400 | OTP_ITEM_MUST_NOT_BE_NULL |
ERR_OTP_4 | 400 | OTP_TRANSACTION_IS_NOT_FOUND |
path Parameters
otpTransactionIdcreate-otp-transaction-log › Request Body
citizenIdisFailedotpTypePermitted values — validated against the otp_type parameter.
| Value | Meaning |
|---|---|
1 | 1 |
Permitted values — validated against the otp_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | OTP | en: 1 · tr: 1 · ar: واحد |
create-otp-transaction-log › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-otp-transaction-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as OtpTransactionDto.
| Field | Declared type | Nullable |
|---|---|---|
OtpItemId | Guid | no |
OneTimePassword | string | no |
EndDate | DateTime? | yes |
StartDate | DateTime? | yes |
RetryDate | DateTime? | yes |
IsConfirmed | bool | no |
PhoneNumber | string | no |
Email | string | no |
KycConfirmed | bool | no |
KycEndDate | DateTime? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_OTP_16 | 400 | OTP_TRANSACTION_IS_EXPIRE | Processing time has expired |
ERR_OTP_4 | 400 | OTP_TRANSACTION_IS_NOT_FOUND | not published in this snapshot |
path Parameters
transactionIdget-otp-transaction-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-otp-item-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as OtpItemDto.
| Field | Declared type | Nullable |
|---|---|---|
KeyFormatId | Guid | no |
Name | string | no |
ValidityDuration | int? | yes |
RetryDuration | int? | yes |
IsActive | bool | no |
RetryCount | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_2 | 400 | OTP_ITEM_IS_NOT_FOUND |
path Parameters
idget-otp-item-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
idisActivekeyFormatIdnameretryCountretryDurationvalidityDurationupdate-otp-item
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_11 | 400 | OTP_ITEM_NAME_HAS_ALREADY_BEEN_DEFINED |
ERR_OTP_2 | 400 | OTP_ITEM_IS_NOT_FOUND |
ERR_OTP_5 | 400 | KEY_FORMAT_MUST_BE_NULL |
path Parameters
idupdate-otp-item › Request Body
isActivekeyFormatIdnameretryCountretryDurationvalidityDurationupdate-otp-item › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-otp-item
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_10 | 400 | OTP_ITEM_IS_USED |
ERR_OTP_2 | 400 | OTP_ITEM_IS_NOT_FOUND |
path Parameters
iddelete-otp-item › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
check-phone-has-pending-transaction
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as CheckPhoneHasPendingTransactionDto.
| Field | Declared type | Nullable |
|---|---|---|
HasPendingTransaction | bool | no |
EndDate | DateTime? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_2 | 400 | OTP_ITEM_IS_NOT_FOUND |
path Parameters
idcheck-phone-has-pending-transaction › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
create-otp-transaction
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as CreateOtpTransactionDto.
| Field | Declared type | Nullable |
|---|---|---|
OneTimePassword | string | no |
EndDate | DateTime? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_15 | 400 | EMAIL_IS_INVALID |
ERR_OTP_2 | 400 | OTP_ITEM_IS_NOT_FOUND |
ERR_OTP_3 | 400 | OTP_ITEM_MUST_NOT_BE_PASSIVE |
ERR_OTP_6 | 400 | KEY_FORMAT_MUST_NOT_BE_NULL |
ERR_OTP_7 | 400 | KEY_FORMAT_MUST_NOT_BE_PASSIVE |
path Parameters
idcreate-otp-transaction › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
has-otp-item-usage
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns bool, a scalar rather than an object. There is no field tree below because there are no fields: the body is the JSON literal true or false. This is a complete answer read from the declaration, not a gap.
path Parameters
idhas-otp-item-usage › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.