Skip to main content

Enroll a customer using picked provider

Allows to enroll customer identified by MSISDN (phone number) using one of the available enrollment providers (e. g. FBN USSD service). Result of the enrollment will be sent with callback data.

Request Body required
  • operationId string required

    Unique operation id of customer enrollment operation request

  • provider CustomerEnrollmentProvider required

    Possible values: [FBN_USSD]

  • customerMsisdn +234'10 digits' or 234'10 digits' or +0'10 digits' or 0'10 digits' or '10 digits' required

    Possible values: Value must match regular expression ^\+?(234|0)?\d{10}$

    MSISDN (phone number), available formats:

    • +234'10 digits' - for example: +2341234567890
    • 234'10 digits' - for example: 2341234567890
    • +0'10 digits' - for example: +01234567890
    • 0'10 digits' - for example: 01234567890
    • '10 digits' - for example: 1234567890
  • recoveryTokenNotificationMethod object
  • oneOf
  • type string required

    Possible values: [SMS]

Responses

Customer enrollment process was initiated

Schema
  • intiationStatus string required

    Possible values: [INITATED, FAILED]

  • message string required

    Human readable message related to the Customer Enrollment operation status

  • recoveryShortcodeString RecoveryShortcode required

    USSD string with recovery token, which can be used by user to dial in when USSD push won't be delivered

Loading...