API docs by Redocly

BNPL AUTH (v1)

API documentation for BNPL AUTH

api

api_v1.0_consumer_idv_create_applicant_generate_token

Authorizations:
Basic
Request Body schema: application/json
required
agreement
boolean or null (Agreement)
object (UserEmbedded)
has_identities_uploaded
boolean or null (Has identities uploaded)

Responses

Request samples

Content type
application/json
{
  • "agreement": true,
  • "user": {
    },
  • "has_identities_uploaded": true
}

Response samples

Content type
application/json
{
  • "agreement": true,
  • "user": {
    },
  • "has_identities_uploaded": true,
  • "has_front_identities_uploaded": "string",
  • "has_back_identities_uploaded": "string",
  • "verification_url": "string",
  • "consumer_identity": "string",
  • "mobile_verify_attempts_left": "string"
}

api_v1.0_consumer_idv_create_checks_generate_report

Authorizations:
Basic
Request Body schema: application/json
required
agreement
boolean or null (Agreement)
object (UserEmbedded)
has_identities_uploaded
boolean or null (Has identities uploaded)

Responses

Request samples

Content type
application/json
{
  • "agreement": true,
  • "user": {
    },
  • "has_identities_uploaded": true
}

Response samples

Content type
application/json
{
  • "agreement": true,
  • "user": {
    },
  • "has_identities_uploaded": true,
  • "has_front_identities_uploaded": "string",
  • "has_back_identities_uploaded": "string",
  • "verification_url": "string",
  • "consumer_identity": "string",
  • "mobile_verify_attempts_left": "string"
}

api_v1.0_consumer_idv_download_document

Authorizations:
Basic
path Parameters
document_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1.0_consumer_idv_read

Authorizations:
Basic
path Parameters
profile_id
required
string <uuid>

A UUID string identifying this profile.

Responses

Response samples

Content type
application/json
{
  • "agreement": true,
  • "user": {
    },
  • "has_identities_uploaded": true,
  • "has_front_identities_uploaded": "string",
  • "has_back_identities_uploaded": "string",
  • "verification_url": "string",
  • "consumer_identity": "string",
  • "mobile_verify_attempts_left": "string"
}

api_v1.0_consumer_password-recovery-request_create

Authorizations:
Basic
Request Body schema: application/json
required
username
required
string (Username) non-empty

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "url": "http://example.com",
  • "username": "string",
  • "password_recovery_request_id": "867b3b64-f9b4-4bdb-97a6-89aee7b889fe"
}

api_v1.0_consumer_password-recovery-request_read

Authorizations:
Basic
path Parameters
password_recovery_request_id
required
string <uuid>

A UUID string identifying this password recovery request.

Responses

Response samples

Content type
application/json
{
  • "update_password_request_id": "6d0bec5b-cfba-4763-8ca2-cd7fdaa7e17f"
}

api_v1.0_consumer_password-recovery-request_update

Authorizations:
Basic
path Parameters
password_recovery_request_id
required
string <uuid>

A UUID string identifying this password recovery request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_password-recovery-request_partial_update

Authorizations:
Basic
path Parameters
password_recovery_request_id
required
string <uuid>

A UUID string identifying this password recovery request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_password-recovery-request_verify_update

Authorizations:
Basic
path Parameters
password_recovery_request_id
required
string <uuid>

A UUID string identifying this password recovery request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_password-recovery-request_verify_partial_update

Authorizations:
Basic
path Parameters
password_recovery_request_id
required
string <uuid>

A UUID string identifying this password recovery request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_profile_read

Authorizations:
Basic
path Parameters
profile_id
required
string <uuid>

A UUID string identifying this profile.

Responses

Response samples

Content type
application/json
{
  • "agreement": true,
  • "user": {
    },
  • "has_identities_uploaded": true,
  • "has_front_identities_uploaded": "string",
  • "has_back_identities_uploaded": "string",
  • "verification_url": "string",
  • "consumer_identity": "string",
  • "mobile_verify_attempts_left": "string"
}

api_v1.0_consumer_registration_create

Authorizations:
Basic
Request Body schema: application/json
required
required
object (RegistrationSessionInitialUser)

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "url": "http://example.com",
  • "user": {
    },
  • "token": "string"
}

api_v1.0_consumer_registration_check_email_allowed

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • { }
]

api_v1.0_consumer_registration_deferred

Authorizations:
Basic
Request Body schema: application/json
required
required
object (RegistrationSessionInitialUser)

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "url": "http://example.com",
  • "user": {
    },
  • "token": "string"
}

api_v1.0_consumer_registration_deferred_signup

Authorizations:
Basic
Request Body schema: application/json
required
required
object (RegistrationSessionInitialUser)

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "url": "http://example.com",
  • "user": {
    },
  • "token": "string"
}

api_v1.0_consumer_registration_verify_token

Authorizations:
Basic
Request Body schema: application/json
required
required
object (RegistrationSessionInitialUser)

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "url": "http://example.com",
  • "user": {
    },
  • "token": "string"
}

api_v1.0_consumer_registration_read

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Responses

Response samples

Content type
application/json
{
  • "user": {
    },
  • "profile": {
    }
}

api_v1.0_consumer_registration_update

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Request Body schema: application/json
required
object (RegistrationSessionInitialUser)
object (RegistartionProfileSerilizer)
Default: {"phone_verified":true}

Responses

Request samples

Content type
application/json
{
  • "user": {
    },
  • "profile": {
    }
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "profile": {
    }
}

api_v1.0_consumer_registration_partial_update

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Request Body schema: application/json
required
object (RegistrationSessionInitialUser)
object (RegistartionProfileSerilizer)
Default: {"phone_verified":true}

Responses

Request samples

Content type
application/json
{
  • "user": {
    },
  • "profile": {
    }
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "profile": {
    }
}

api_v1.0_consumer_registration_validate_update

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Request Body schema: application/json
required
object (RegistrationSessionValidateSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_consumer_registration_validate_partial_update

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Request Body schema: application/json
required
object (RegistrationSessionValidateSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_consumer_registration_verify_update

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_registration_verify_partial_update

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_set-password-request_create

Authorizations:
Basic

Responses

api_v1.0_consumer_update-email_list

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1.0_consumer_update-email_create

Authorizations:
Basic
Request Body schema: application/json
required
new_email
required
string <email> (New email) non-empty

Responses

Request samples

Content type
application/json
{
  • "new_email": "user@example.com"
}

Response samples

Content type
application/json
{}

api_v1.0_consumer_update-email_verify_update

Authorizations:
Basic
path Parameters
jwt_token
required
string
Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_update-email_verify_partial_update

Authorizations:
Basic
path Parameters
jwt_token
required
string
Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_update-email_read

Authorizations:
Basic
path Parameters
update_email_session_id
required
string <uuid>

A UUID string identifying this update email session.

Responses

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "new_email": "user@example.com"
}

api_v1.0_consumer_update-email_update

Authorizations:
Basic
path Parameters
update_email_session_id
required
string <uuid>

A UUID string identifying this update email session.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_update-email_partial_update

Authorizations:
Basic
path Parameters
update_email_session_id
required
string <uuid>

A UUID string identifying this update email session.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_update-password-request_create

Authorizations:
Basic
Request Body schema: application/json
required
new_password
required
string (New password) non-empty
confirm_new_password
required
string (Confirm new password) non-empty

Responses

Request samples

Content type
application/json
{
  • "new_password": "string",
  • "confirm_new_password": "string"
}

Response samples

Content type
application/json
{}

api_v1.0_consumer_update-password-request_read

Authorizations:
Basic
path Parameters
update_password_request_id
required
string <uuid>

A UUID string identifying this update password request.

Responses

Response samples

Content type
application/json
{
  • "update_password_request_id": "6d0bec5b-cfba-4763-8ca2-cd7fdaa7e17f"
}

api_v1.0_consumer_update-password-request_update

Authorizations:
Basic
path Parameters
update_password_request_id
required
string <uuid>

A UUID string identifying this update password request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_update-password-request_partial_update

Authorizations:
Basic
path Parameters
update_password_request_id
required
string <uuid>

A UUID string identifying this update password request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_update_email_list

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1.0_consumer_update_email_create

Authorizations:
Basic
Request Body schema: application/json
required
new_email
required
string <email> (New email) non-empty

Responses

Request samples

Content type
application/json
{
  • "new_email": "user@example.com"
}

Response samples

Content type
application/json
{}

api_v1.0_consumer_update_email_verify_update

Authorizations:
Basic
path Parameters
jwt_token
required
string
Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_update_email_verify_partial_update

Authorizations:
Basic
path Parameters
jwt_token
required
string
Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_update_email_read

Authorizations:
Basic
path Parameters
update_email_session_id
required
string <uuid>

A UUID string identifying this update email session.

Responses

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "new_email": "user@example.com"
}

api_v1.0_consumer_update_email_update

Authorizations:
Basic
path Parameters
update_email_session_id
required
string <uuid>

A UUID string identifying this update email session.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_update_email_partial_update

Authorizations:
Basic
path Parameters
update_email_session_id
required
string <uuid>

A UUID string identifying this update email session.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_update_password_request_create

Authorizations:
Basic
Request Body schema: application/json
required
new_password
required
string (New password) non-empty
confirm_new_password
required
string (Confirm new password) non-empty

Responses

Request samples

Content type
application/json
{
  • "new_password": "string",
  • "confirm_new_password": "string"
}

Response samples

Content type
application/json
{}

api_v1.0_consumer_update_password_request_read

Authorizations:
Basic
path Parameters
update_password_request_id
required
string <uuid>

A UUID string identifying this update password request.

Responses

Response samples

Content type
application/json
{
  • "update_password_request_id": "6d0bec5b-cfba-4763-8ca2-cd7fdaa7e17f"
}

api_v1.0_consumer_update_password_request_update

Authorizations:
Basic
path Parameters
update_password_request_id
required
string <uuid>

A UUID string identifying this update password request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_update_password_request_partial_update

Authorizations:
Basic
path Parameters
update_password_request_id
required
string <uuid>

A UUID string identifying this update password request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_consumer_upload-identity_list

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1.0_consumer_upload-identity_filter

Authorizations:
Basic
Request Body schema: application/json
required
age_filters
required
Array of strings or null
region_filters
required
Array of strings or null
gender_filters
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "age_filters": [
    ],
  • "region_filters": [
    ],
  • "gender_filters": [
    ]
}

Response samples

Content type
application/json
{
  • "users": "string",
  • "age_filters": [
    ],
  • "region_filters": [
    ],
  • "gender_filters": [
    ]
}

api_v1.0_consumer_upload-identity_get_nfc_auth_token

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1.0_consumer_upload-identity_get_risk_nfc_status

Authorizations:
Basic
Request Body schema: application/json
required
country
required
string (Country) non-empty

Responses

Request samples

Content type
application/json
{
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "country": "string"
}

api_v1.0_consumer_upload-identity_process_nfc_data

Authorizations:
Basic
Request Body schema: application/json
required
token
string or null (Token)
country
required
string (Country) non-empty
scan_status
string or null (Scan status)

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "country": "string",
  • "scan_status": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "country": "string",
  • "scan_status": "string"
}

api_v1.0_consumer_upload-identity_upload

Authorizations:
Basic
Request Body schema: multipart/form-data
required
type
required
string
Enum: "front" "back"
file
required
string <binary>
user_id
string or null
country
required
string [ 1 .. 3 ] characters
checkout
boolean or null
Default: false

Responses

Response samples

Content type
application/json
{}

api_v1.0_consumer_upload-identity_read

Authorizations:
Basic
path Parameters
identity_id
required
string <uuid>

A UUID string identifying this identity.

Responses

Response samples

Content type
application/json
{
  • "identity_id": "011a42b9-62d7-49eb-8328-c2e454af88a1",
  • "id_number": "string",
  • "name": "string",
  • "nationality": "string",
  • "card_number": "string",
  • "dob": "string",
  • "sex": "string",
  • "expiry_date": "string",
  • "meta_data": { }
}

api_v1.0_internal_consumer_list

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1.0_internal_consumer_change_email

Authorizations:
Basic
Request Body schema: application/json
required
new_email
string (New email) non-empty
old_email
string (Old email) non-empty

Responses

Request samples

Content type
application/json
{
  • "new_email": "string",
  • "old_email": "string"
}

Response samples

Content type
application/json
{
  • "new_email": "string",
  • "old_email": "string"
}

api_v1.0_internal_consumer_get_user_details

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1.0_internal_consumer_manual_id_update

Authorizations:
Basic
Request Body schema: multipart/form-data
id_number
string <= 255 characters
card_number
string or null <= 255 characters
name
string <= 255 characters
sex
string or null <= 255 characters
nationality
string <= 255 characters
email
required
string [ 1 .. 50 ] characters
expiry_date
required
string <date>
dob
required
string <date>
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id_number": "string",
  • "card_number": "string",
  • "name": "string",
  • "sex": "string",
  • "nationality": "string",
  • "email": "string",
  • "expiry_date": "2019-08-24",
  • "dob": "2019-08-24",
  • "file": "http://example.com"
}

api_v1.0_internal_consumer_send_otp

Authorizations:
Basic
Request Body schema: application/json
required
destination
required
string (Destination) [ 1 .. 50 ] characters
otp_type
required
string (Otp type) [ 1 .. 20 ] characters

Responses

Request samples

Content type
application/json
{
  • "destination": "string",
  • "otp_type": "string"
}

Response samples

Content type
application/json
{
  • "destination": "string",
  • "otp_type": "string"
}

api_v1.0_internal_consumer_update_phone

Authorizations:
Basic
Request Body schema: application/json
required
phone_numbers
required
object (Phone numbers)
email
required
string <email> (Email) non-empty

Responses

Request samples

Content type
application/json
{
  • "phone_numbers": { },
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "phone_numbers": { },
  • "email": "user@example.com"
}

api_v1.0_internal_consumer_update_user_info

Authorizations:
Basic
Request Body schema: application/json
required
user_id
string or null (User id)
email
string or null (Email)
is_active
string or null (Is active)
phone_no
string or null (Phone no)
dob
string <date> (Dob)

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "email": "string",
  • "is_active": "string",
  • "phone_no": "string",
  • "dob": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "email": "string",
  • "is_active": "string",
  • "phone_no": "string",
  • "dob": "2019-08-24"
}

api_v1.0_internal_consumer_read

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

Response samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "phone_number": "string",
  • "date_of_birth": "2019-08-24",
  • "is_staff": true,
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "profile": {
    },
  • "identities": [
    ],
  • "has_identities_lock": "string",
  • "is_deferred_sign_up": true
}

api_v1.0_internal_consumer_send_set_password_email

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

Response samples

Content type
application/json
{ }

api_v1.0_internal_employee_list

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1.0_internal_employee_create

Authorizations:
Basic
Request Body schema: application/json
required
object (UserEmbedded)

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user": {
    }
}

api_v1.0_internal_employee_check_email

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1.0_internal_employee_read

Authorizations:
Basic
path Parameters
user__user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user": {
    }
}

api_v1.0_internal_employee_update

Authorizations:
Basic
path Parameters
user__user_id
required
string
Request Body schema: application/json
required
object (UserEmbedded)

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user": {
    }
}

api_v1.0_internal_employee_partial_update

Authorizations:
Basic
path Parameters
user__user_id
required
string
Request Body schema: application/json
required
object (UserEmbedded)

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user": {
    }
}

api_v1.0_internal_merchant_list

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1.0_internal_merchant_authentication_read

Authorizations:
Basic
path Parameters
public_key
required
string

Responses

Response samples

Content type
application/json
{
  • "public_key": "string",
  • "private_key": "string",
  • "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8"
}

api_v1.0_internal_merchant_authentication_private

Authorizations:
Basic
path Parameters
public_key
required
string

Responses

Response samples

Content type
application/json
{
  • "public_key": "string",
  • "private_key": "string",
  • "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8"
}

api_v1.0_internal_merchant_read

Authorizations:
Basic
path Parameters
profile_id
required
string <uuid>

A UUID string identifying this profile.

Responses

Response samples

Content type
application/json
{
  • "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
  • "legal_business_name": "string",
  • "business_support_phone_number": "string",
  • "business_support_email": "user@example.com",
  • "business_sector": "string",
  • "line1": "string",
  • "city": "string",
  • "state": "string",
  • "postcode": "string",
  • "approved_at": "2019-08-24T14:15:22Z",
  • "country_id": "string",
  • "trn_number": "string",
  • "public_key": "string",
  • "tenant_id": "string"
}

api_v1.0_merchant_authentication_create

Authorizations:
Basic
Request Body schema: application/json
required
public_key
required
string (Public key) non-empty
private_key
required
string (Private key) non-empty

Responses

Request samples

Content type
application/json
{
  • "public_key": "string",
  • "private_key": "string"
}

Response samples

Content type
application/json
{
  • "public_key": "string",
  • "private_key": "string"
}

api_v1.0_merchant_password-recovery-request_create

Authorizations:
Basic
Request Body schema: application/json
required
username
required
string (Username) non-empty
tenant_id
required
string (Tenant id) non-empty

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "tenant_id": "string"
}

Response samples

Content type
application/json
{
  • "url": "http://example.com",
  • "username": "string",
  • "password_recovery_request_id": "867b3b64-f9b4-4bdb-97a6-89aee7b889fe",
  • "tenant_id": "string"
}

api_v1.0_merchant_password-recovery-request_read

Authorizations:
Basic
path Parameters
password_recovery_request_id
required
string <uuid>

A UUID string identifying this password recovery request.

Responses

Response samples

Content type
application/json
{
  • "update_password_request_id": "6d0bec5b-cfba-4763-8ca2-cd7fdaa7e17f"
}

api_v1.0_merchant_password-recovery-request_update

Authorizations:
Basic
path Parameters
password_recovery_request_id
required
string <uuid>

A UUID string identifying this password recovery request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_merchant_password-recovery-request_partial_update

Authorizations:
Basic
path Parameters
password_recovery_request_id
required
string <uuid>

A UUID string identifying this password recovery request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_merchant_password-recovery-request_verify_update

Authorizations:
Basic
path Parameters
password_recovery_request_id
required
string <uuid>

A UUID string identifying this password recovery request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_merchant_password-recovery-request_verify_partial_update

Authorizations:
Basic
path Parameters
password_recovery_request_id
required
string <uuid>

A UUID string identifying this password recovery request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_merchant_profile_read

Authorizations:
Basic
path Parameters
employee_id
required
string <uuid>

A UUID string identifying this employee.

Responses

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user": {
    },
  • "merchant": {
    }
}

api_v1.0_merchant_registration_create

Merchant registration flow

Authorizations:
Basic
Request Body schema: application/json
required
required
object (RegistrationSessionInitialUser)

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "url": "http://example.com",
  • "user": {
    },
  • "token": "string"
}

api_v1.0_merchant_registration_read

Merchant registration flow

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Responses

Response samples

Content type
application/json
{
  • "user": {
    },
  • "profile": {
    }
}

api_v1.0_merchant_registration_update

Merchant registration flow

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Request Body schema: application/json
required
object (RegistrationSessionInitialUser)
object (RegistartionProfileSerilizer)
Default: {"phone_verified":true}

Responses

Request samples

Content type
application/json
{
  • "user": {
    },
  • "profile": {
    }
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "profile": {
    }
}

api_v1.0_merchant_registration_partial_update

Merchant registration flow

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Request Body schema: application/json
required
object (RegistrationSessionInitialUser)
object (RegistartionProfileSerilizer)
Default: {"phone_verified":true}

Responses

Request samples

Content type
application/json
{
  • "user": {
    },
  • "profile": {
    }
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "profile": {
    }
}

api_v1.0_merchant_registration_validate_update

Merchant registration flow

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Request Body schema: application/json
required
object (RegistrationSessionValidateSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_merchant_registration_validate_partial_update

Merchant registration flow

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Request Body schema: application/json
required
object (RegistrationSessionValidateSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_merchant_registration_verify_update

Merchant registration flow

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "token": "string"
}

api_v1.0_merchant_registration_verify_partial_update

Merchant registration flow

Authorizations:
Basic
path Parameters
registration_session_id
required
string <uuid>

A UUID string identifying this registration session.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "token": "string"
}

api_v1.0_merchant_update-password-request_create

Authorizations:
Basic
Request Body schema: application/json
required
new_password
required
string (New password) non-empty
confirm_new_password
required
string (Confirm new password) non-empty

Responses

Request samples

Content type
application/json
{
  • "new_password": "string",
  • "confirm_new_password": "string"
}

Response samples

Content type
application/json
{}

api_v1.0_merchant_update-password-request_read

Authorizations:
Basic
path Parameters
update_password_request_id
required
string <uuid>

A UUID string identifying this update password request.

Responses

Response samples

Content type
application/json
{
  • "update_password_request_id": "6d0bec5b-cfba-4763-8ca2-cd7fdaa7e17f"
}

api_v1.0_merchant_update-password-request_update

Authorizations:
Basic
path Parameters
update_password_request_id
required
string <uuid>

A UUID string identifying this update password request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_merchant_update-password-request_partial_update

Authorizations:
Basic
path Parameters
update_password_request_id
required
string <uuid>

A UUID string identifying this update password request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_merchant_update_password_request_create

Authorizations:
Basic
Request Body schema: application/json
required
new_password
required
string (New password) non-empty
confirm_new_password
required
string (Confirm new password) non-empty

Responses

Request samples

Content type
application/json
{
  • "new_password": "string",
  • "confirm_new_password": "string"
}

Response samples

Content type
application/json
{}

api_v1.0_merchant_update_password_request_read

Authorizations:
Basic
path Parameters
update_password_request_id
required
string <uuid>

A UUID string identifying this update password request.

Responses

Response samples

Content type
application/json
{
  • "update_password_request_id": "6d0bec5b-cfba-4763-8ca2-cd7fdaa7e17f"
}

api_v1.0_merchant_update_password_request_update

Authorizations:
Basic
path Parameters
update_password_request_id
required
string <uuid>

A UUID string identifying this update password request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_merchant_update_password_request_partial_update

Authorizations:
Basic
path Parameters
update_password_request_id
required
string <uuid>

A UUID string identifying this update password request.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "string"
}

api_v1.0_push-notifications_list

Push notifications is a convenient way to get notified about events from the system. One can register a callback, i.e a valid URL that will be called whenever there is an event dispatched for this subscriber. Note that this can result in a large numbers of calls

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1.0_push-notifications_create

Push notifications is a convenient way to get notified about events from the system. One can register a callback, i.e a valid URL that will be called whenever there is an event dispatched for this subscriber. Note that this can result in a large numbers of calls

Authorizations:
Basic
Request Body schema: application/json
required
callback_url
required
string <uri> (Callback url) [ 1 .. 2000 ] characters
pattern
required
string (Pattern) [ 1 .. 10000 ] characters

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "push_notification_id": "cacdffe7-24e1-44b8-b52e-25a696016787",
  • "callback_url": "http://example.com",
  • "pattern": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_push-notifications_read

Push notifications is a convenient way to get notified about events from the system. One can register a callback, i.e a valid URL that will be called whenever there is an event dispatched for this subscriber. Note that this can result in a large numbers of calls

Authorizations:
Basic
path Parameters
push_notification_id
required
string <uuid>

A UUID string identifying this push notification.

Responses

Response samples

Content type
application/json
{
  • "push_notification_id": "cacdffe7-24e1-44b8-b52e-25a696016787",
  • "callback_url": "http://example.com",
  • "pattern": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_push-notifications_delete

Push notifications is a convenient way to get notified about events from the system. One can register a callback, i.e a valid URL that will be called whenever there is an event dispatched for this subscriber. Note that this can result in a large numbers of calls

Authorizations:
Basic
path Parameters
push_notification_id
required
string <uuid>

A UUID string identifying this push notification.

Responses

api_v1.0_tenant_list

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1.0_tenant_create

Authorizations:
Basic
Request Body schema: application/json
required
external_key
string or null (External key) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters
client_key
required
string or null (Client key) <= 255 characters
client_secret
required
string or null (Client secret) <= 255 characters
auth_url
string or null (Auth url) <= 255 characters
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "name": "string",
  • "client_key": "string",
  • "client_secret": "string",
  • "auth_url": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "external_key": "string",
  • "name": "string",
  • "client_key": "string",
  • "client_secret": "string",
  • "auth_url": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_tenant_read

Authorizations:
Basic
path Parameters
tenant_id
required
string <uuid>

A UUID string identifying this tenant.

Responses

Response samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "external_key": "string",
  • "name": "string",
  • "client_key": "string",
  • "client_secret": "string",
  • "auth_url": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_tenant_delete

Authorizations:
Basic
path Parameters
tenant_id
required
string <uuid>

A UUID string identifying this tenant.

Responses

api_v1.0_user_avatar_create

Authorizations:
Basic
Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "avatar_id": "ceaabbd8-6fdf-460c-878c-7d0ae67338c0",
  • "file": "http://example.com",
  • "default_image": "string",
  • "image_144x144": "string",
  • "image_288x288": "string",
  • "image_64x64": "string"
}

api_v1.0_user_otp_login

Authorizations:
Basic
Request Body schema: application/json
required
email
string or null (Email) <= 255 characters
phone_number
string or null (Phone number) <= 255 characters
resend
boolean (Resend)
Default: false
phone_verification_id
string or null (Phone verification id) <= 255 characters
tenant_id
string or null (Tenant id) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone_number": "string",
  • "resend": false,
  • "phone_verification_id": "string",
  • "tenant_id": "string"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "phone_number": "string",
  • "resend": false,
  • "phone_verification_id": "string",
  • "tenant_id": "string"
}

api_v1.0_user_signin

Authorizations:
Basic
Request Body schema: application/json
required
login_challenge
required
string (Login challenge) non-empty
username
required
string (Username) non-empty
password
required
string (Password) non-empty
checkoutId
string or null (Checkoutid)
reg_identification_id
string or null (Reg identification id)
user_identity_id
string or null (User identity id)
phone_verification_id
string or null (Phone verification id)
tenantId
string or null (Tenantid)

Responses

Request samples

Content type
application/json
{
  • "login_challenge": "string",
  • "username": "string",
  • "password": "string",
  • "checkoutId": "string",
  • "reg_identification_id": "string",
  • "user_identity_id": "string",
  • "phone_verification_id": "string",
  • "tenantId": "string"
}

Response samples

Content type
application/json
{
  • "login_challenge": "string",
  • "username": "string",
  • "password": "string",
  • "checkoutId": "string",
  • "reg_identification_id": "string",
  • "user_identity_id": "string",
  • "phone_verification_id": "string",
  • "tenantId": "string"
}

api_v1.0_user_token_signin_create

Authorizations:
Basic
Request Body schema: application/json
required
token
required
string (Token) non-empty
login_challenge
required
string (Login challenge) non-empty

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "login_challenge": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "login_challenge": "string"
}

api_v1.0_user_delete

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_user_update_details_create

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
first_name
string or null (First name)
last_name
string or null (Last name)
phone_number
string or null (Phone number)
date_of_birth
string or null <date> (Date of birth)
card_expiry_date
string or null (Card expiry date)
card_id_number
string or null (Card id number)
card_card_number
string or null (Card card number)

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "phone_number": "string",
  • "date_of_birth": "2019-08-24",
  • "card_expiry_date": "string",
  • "card_id_number": "string",
  • "card_card_number": "string"
}

Response samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "phone_number": "string",
  • "date_of_birth": "2019-08-24",
  • "card_expiry_date": "string",
  • "card_id_number": "string",
  • "card_card_number": "string"
}

api_v1.0_user_update_details_partial_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
first_name
string or null (First name)
last_name
string or null (Last name)
phone_number
string or null (Phone number)
date_of_birth
string or null <date> (Date of birth)
card_expiry_date
string or null (Card expiry date)
card_id_number
string or null (Card id number)
card_card_number
string or null (Card card number)

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "phone_number": "string",
  • "date_of_birth": "2019-08-24",
  • "card_expiry_date": "string",
  • "card_id_number": "string",
  • "card_card_number": "string"
}

Response samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "phone_number": "string",
  • "date_of_birth": "2019-08-24",
  • "card_expiry_date": "string",
  • "card_id_number": "string",
  • "card_card_number": "string"
}

api_v1.0_verification_email_create

Authorizations:
Basic
Request Body schema: application/json
required
email
required
string <email> (Email) [ 1 .. 254 ] characters

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "email_verification_token_id": "d24a8284-ce0a-48ad-a599-9368a8641e8e",
  • "email": "user@example.com"
}

api_v1.0_verification_email_read

Authorizations:
Basic
path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "email_verification_token_id": "d24a8284-ce0a-48ad-a599-9368a8641e8e",
  • "email": "user@example.com"
}

api_v1.0_verification_email_update

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
email
required
string <email> (Email) [ 1 .. 254 ] characters

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "email_verification_token_id": "d24a8284-ce0a-48ad-a599-9368a8641e8e",
  • "email": "user@example.com"
}

api_v1.0_verification_email_partial_update

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
email
required
string <email> (Email) [ 1 .. 254 ] characters

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "email_verification_token_id": "d24a8284-ce0a-48ad-a599-9368a8641e8e",
  • "email": "user@example.com"
}

api_v1.0_verification_phone-verification-tokens_create

API endpoint that allow create and verify phone OTP codes

Authorizations:
Basic
Request Body schema: application/json
required
phone
required
string (Phone) [ 1 .. 128 ] characters
tenant_id
required
string (Tenant id) non-empty
code_length
integer or null (Code length)

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

Response samples

Content type
application/json
{
  • "phone_verification_token_id": "49f4e95b-4d7c-4c93-8e04-07977641eeff",
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

api_v1.0_verification_phone-verification-tokens_read

API endpoint that allow create and verify phone OTP codes

Authorizations:
Basic
path Parameters
phone_verification_token_id
required
string <uuid>

A UUID string identifying this phone verification token.

Responses

Response samples

Content type
application/json
{
  • "phone_verification_token_id": "49f4e95b-4d7c-4c93-8e04-07977641eeff",
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

api_v1.0_verification_phone-verification-tokens_update

API endpoint that allow create and verify phone OTP codes

Authorizations:
Basic
path Parameters
phone_verification_token_id
required
string <uuid>

A UUID string identifying this phone verification token.

Request Body schema: application/json
required
phone
required
string (Phone) [ 1 .. 128 ] characters
tenant_id
required
string (Tenant id) non-empty
code_length
integer or null (Code length)

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

Response samples

Content type
application/json
{
  • "phone_verification_token_id": "49f4e95b-4d7c-4c93-8e04-07977641eeff",
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

api_v1.0_verification_phone-verification-tokens_partial_update

API endpoint that allow create and verify phone OTP codes

Authorizations:
Basic
path Parameters
phone_verification_token_id
required
string <uuid>

A UUID string identifying this phone verification token.

Request Body schema: application/json
required
phone
required
string (Phone) [ 1 .. 128 ] characters
tenant_id
required
string (Tenant id) non-empty
code_length
integer or null (Code length)

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

Response samples

Content type
application/json
{
  • "phone_verification_token_id": "49f4e95b-4d7c-4c93-8e04-07977641eeff",
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

api_v1.0_verification_phone-verification-tokens_resend

API endpoint that allow create and verify phone OTP codes

Authorizations:
Basic
path Parameters
phone_verification_token_id
required
string <uuid>

A UUID string identifying this phone verification token.

Responses

api_v1.0_verification_phone-verification-tokens_verify

API endpoint that allow create and verify phone OTP codes

Authorizations:
Basic
path Parameters
phone_verification_token_id
required
string <uuid>

A UUID string identifying this phone verification token.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "validation_token": "94424f71-0242-44a4-9d92-23f5ca1d1254",
  • "code": "string"
}

api_v1.0_verification_phone_verification_tokens_create

API endpoint that allow create and verify phone OTP codes

Authorizations:
Basic
Request Body schema: application/json
required
phone
required
string (Phone) [ 1 .. 128 ] characters
tenant_id
required
string (Tenant id) non-empty
code_length
integer or null (Code length)

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

Response samples

Content type
application/json
{
  • "phone_verification_token_id": "49f4e95b-4d7c-4c93-8e04-07977641eeff",
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

api_v1.0_verification_phone_verification_tokens_read

API endpoint that allow create and verify phone OTP codes

Authorizations:
Basic
path Parameters
phone_verification_token_id
required
string <uuid>

A UUID string identifying this phone verification token.

Responses

Response samples

Content type
application/json
{
  • "phone_verification_token_id": "49f4e95b-4d7c-4c93-8e04-07977641eeff",
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

api_v1.0_verification_phone_verification_tokens_update

API endpoint that allow create and verify phone OTP codes

Authorizations:
Basic
path Parameters
phone_verification_token_id
required
string <uuid>

A UUID string identifying this phone verification token.

Request Body schema: application/json
required
phone
required
string (Phone) [ 1 .. 128 ] characters
tenant_id
required
string (Tenant id) non-empty
code_length
integer or null (Code length)

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

Response samples

Content type
application/json
{
  • "phone_verification_token_id": "49f4e95b-4d7c-4c93-8e04-07977641eeff",
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

api_v1.0_verification_phone_verification_tokens_partial_update

API endpoint that allow create and verify phone OTP codes

Authorizations:
Basic
path Parameters
phone_verification_token_id
required
string <uuid>

A UUID string identifying this phone verification token.

Request Body schema: application/json
required
phone
required
string (Phone) [ 1 .. 128 ] characters
tenant_id
required
string (Tenant id) non-empty
code_length
integer or null (Code length)

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

Response samples

Content type
application/json
{
  • "phone_verification_token_id": "49f4e95b-4d7c-4c93-8e04-07977641eeff",
  • "phone": "string",
  • "tenant_id": "string",
  • "code_length": 0
}

api_v1.0_verification_phone_verification_tokens_resend

API endpoint that allow create and verify phone OTP codes

Authorizations:
Basic
path Parameters
phone_verification_token_id
required
string <uuid>

A UUID string identifying this phone verification token.

Responses

api_v1.0_verification_phone_verification_tokens_verify

API endpoint that allow create and verify phone OTP codes

Authorizations:
Basic
path Parameters
phone_verification_token_id
required
string <uuid>

A UUID string identifying this phone verification token.

Request Body schema: application/json
required
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "validation_token": "94424f71-0242-44a4-9d92-23f5ca1d1254",
  • "code": "string"
}

oauth2

oauth2_auth

Authorizations:
Basic

Responses

oauth2_revoke

Authorizations:
Basic

Responses

oauth2_token

Authorizations:
Basic

Responses