Notifications

Download Spec

List account notifications

get /v1/{tenantName}/accounts/{userId}/notifications

List of the latest notifications for the account.

tenantName

string

required

The name of the tenant.

userId

number

required

filter

string

limit

number

offset

number

orderBy

string

Response

Examples Schema

Successful operation

[
  {
    "createdAt": 123.0,
    "id": 123.0,
    "link": "string",
    "messageType": "idnow_link",
    "state": "SEEN",
    "type": "ERROR",
    "updatedAt": 123.0,
    "userId": 123.0
  }
]

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

array[object]

object

createdAt

number

id

number

link

string

messageType

string

Notification message type.

  • "idnow_link": Notification idnow link.
  • "market_payment_failure": Notification market payment failure.
  • "market_payment_success": Notification market payment success.
  • "user_email_needs_verify": Notification user email needs verify.
  • "user_email_verified": Notification user email verified.
  • "user_kyc_process_failure": Notification user kyc process failure.
  • "user_kyc_processed_success": Notification user kyc processed success.
  • "user_kyc_submitted": Notification user kyc submitted.
  • "user_needs_kyc": Notification user needs kyc.
  • "wallet_aml_screening_not_successful": Notification wallet aml not successful.
  • "wallet_verified": Notification wallet verified.
Enum
  • idnow_link
  • market_payment_failure
  • market_payment_success
  • user_email_needs_verify
  • user_email_verified
  • user_kyc_process_failure
  • user_kyc_processed_success
  • user_kyc_submitted
  • user_needs_kyc
  • wallet_aml_screening_not_successful
  • wallet_verified

state

string

Notification state.

  • "SEEN": Notification has been seen by the user.
  • "UNSEEN": Notification has not been seen by the user.
Enum
  • SEEN
  • UNSEEN

type

string

Notification types.

  • "ERROR": This is an error.
  • "INFORMATION": This is an information.
  • "SUCCESS": This is a success.
  • "WARNING": This is a warning.
Enum
  • ERROR
  • INFORMATION
  • SUCCESS
  • WARNING

updatedAt

number

userId

number

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Update account notification

put /v1/{tenantName}/accounts/{userId}/notifications/{notificationId}

Update the status of the notification.

tenantName

string

required

The name of the tenant.

userId

number

required

notificationId

number

required

state

string

Notification state.

  • "SEEN": Notification has been seen by the user.
  • "UNSEEN": Notification has not been seen by the user.
Enum
  • SEEN
  • UNSEEN

Request

{
  "state": "SEEN"
}

Response

Examples Schema

Successful operation

[
  {
    "createdAt": 123.0,
    "id": 123.0,
    "link": "string",
    "messageType": "idnow_link",
    "state": "SEEN",
    "type": "ERROR",
    "updatedAt": 123.0,
    "userId": 123.0
  }
]

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

array[object]

object

createdAt

number

id

number

link

string

messageType

string

Notification message type.

  • "idnow_link": Notification idnow link.
  • "market_payment_failure": Notification market payment failure.
  • "market_payment_success": Notification market payment success.
  • "user_email_needs_verify": Notification user email needs verify.
  • "user_email_verified": Notification user email verified.
  • "user_kyc_process_failure": Notification user kyc process failure.
  • "user_kyc_processed_success": Notification user kyc processed success.
  • "user_kyc_submitted": Notification user kyc submitted.
  • "user_needs_kyc": Notification user needs kyc.
  • "wallet_aml_screening_not_successful": Notification wallet aml not successful.
  • "wallet_verified": Notification wallet verified.
Enum
  • idnow_link
  • market_payment_failure
  • market_payment_success
  • user_email_needs_verify
  • user_email_verified
  • user_kyc_process_failure
  • user_kyc_processed_success
  • user_kyc_submitted
  • user_needs_kyc
  • wallet_aml_screening_not_successful
  • wallet_verified

state

string

Notification state.

  • "SEEN": Notification has been seen by the user.
  • "UNSEEN": Notification has not been seen by the user.
Enum
  • SEEN
  • UNSEEN

type

string

Notification types.

  • "ERROR": This is an error.
  • "INFORMATION": This is an information.
  • "SUCCESS": This is a success.
  • "WARNING": This is a warning.
Enum
  • ERROR
  • INFORMATION
  • SUCCESS
  • WARNING

updatedAt

number

userId

number

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Was this page helpful?