NovoPayment Onboarding API

---
openapi: 3.0.0
info:
  description: >
    The Onboarding API, groups together a pool of operations for the
    creation of a request for a digital bank account.


    Below operations are available for onboarding API


    **Validate Identity Document**.


    This operation verifies that the Identity Document sent is not registered with active status.

    
    **Device Registration**


    This operation allows to register a new device or update an existing one.


    **Token Update**


    This operation allows to register or update a push token of a device. This
    token is used to send notifications related to transactional and
    non-transactional flows.

    * Applies only for Android and iOS platforms.


    **Onboarding Session**


    This operation allows to originate a registration session with the purpose
    of creating an account.


    **Session Summary**


    This operation allows to recover a previously created registration session
    in order to continue with a previous process.


    **Get Terms and Conditions**


    This operation obtains terms and conditions in HTML format to be displayed
    in a web view.


    **Accept Terms and Conditions**


    This operation allows to accept different legal elements such as:
      - Acceptance of terms and conditions
      - Declaration of being of legal age.
      - Receive marketing notifications.

    **Membership Payment**


    This operation allows to process the subscription payment using a card with
    e-commerce features.


    **Get Biometric Applicant Id**


    This operation generates a new biometric identifier (applicant-id) required
    to start the registration process and biometric validation of the individual
    customer.

    As a result, the operation generates a new applicant ID and a new URL so the
    biometric capture process can be started from the end customer's web and
    mobile channels.

    **Note:** The biometric registration process incorporates the registration
    of the identity documents of the end-customer.

    **Residence Address**


    This operation allows to save the information of the customer's home address.


    **Personal Information**


    This operation allows to save the gender information, civil status,
    education level and any other field that complements the customer's personal
    information.


    **OTP Request Via SMS or E-mail**


    This operation requests a One Time Password (OTP) by SMS or e-mail to
    validate the cellphone number or email.


    **OTP Verification**


    This operation verifies the OTP sent and records the cell phone number or
    E-mail.


    **Occupation**


    This operation allows to define and save the current occupation of the
    customer.


    **Other Type of Occupation**


    This operation allows to define and save an occupation other than student,
    independent and dependent.


    **Income Source**


    This operation allows to specify the income of the customer.


    **Expected Account Activity**


    This operation allows to save the responses of the expected account
    activity, defined by the tenant.


    **Regulatory Questions**


    This operation allows to save the answers to the questionnaire for
    regulatory questions, defined by the tenant.


    **Get Customer's Support Documents**


    This operation checks the list of documents required for the verification
    and support of the account, which is requested based on the responses of
    previous actions in the registration process and the parameterization
    stipulated by the tenant.


    **Upload Support Document**


    This operation allows to register the documents requested for the account
    verification.


    **User Creation**


    This operation allows to create user credentials, accompanied by the
    automatic approval request of the account. In case of presenting open
    escalations, the registration process will remain in a "Pending to Review"
    status, requesting manual approval of the team responsible for the tenant.


    **Approve Account**


    This operation allows the approval or rejection of a registration request,
    resulting in the creation of an account or also the creation of a card,
    this will depend on the configuration have selected.
  version: v1
  title: Onboarding API
servers:
  - description: Sandbox
    url: https://sandbox-api.novopayment.com/onboarding/v1
paths:
  /personal/documentverify:
    post:
      summary: Validate Identity Document
      description: >
        This operation verifies that the sent Identity Document is not registered with active status.
      requestBody:
        $ref: "#/components/requestBodies/RQValidarDocId"
      operationId: DocIdVerification
      responses:
        "200":
          $ref: "#/components/responses/RSValidarDocId200"
        "400":
          $ref: "#/components/responses/RSValidarDocId400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /device:
    post:
      summary: Device Registration
      description: >
        This operation allows to register a new device or update an existing one.
      requestBody:
        $ref: "#/components/requestBodies/RQDeviceRegistration"
      operationId: DeviceRegistration
      responses:
        "200":
          $ref: "#/components/responses/RSDeviceRegistration200"
        "400":
          $ref: "#/components/responses/RSDeviceRegistration400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /device/pushtoken:
    post:
      summary: Token Update
      description: >
        This operation allows to register or update a push token of a
        device. This token is used to send notifications related to
        transactional and non-transactional flows.

        * Applies only for Android and iOS platforms.
      requestBody:
        $ref: "#/components/requestBodies/RQTokenUpdate"
      operationId: TokenUpdate
      responses:
        "200":
          $ref: "#/components/responses/RSTokenUpdate200"
        "400":
          $ref: "#/components/responses/RSTokenUpdate400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /session:
    get:
      summary: Onboarding Session
      description: >
        This operation allows to originate a registration session with the
        purpose of creating an account.
      operationId: OnboardingSession
      responses:
        "200":
          $ref: "#/components/responses/RSOnboardingSession200"
        "400":
          $ref: "#/components/responses/RSOnboardingSession400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /session/resume:
    post:
      summary: Session Summary
      description: >
        This operation allows to recover a previously created registration
        session in order to continue with a previous process.
      requestBody:
        $ref: "#/components/requestBodies/RQSessionSummary"
      operationId: SessionSummary
      responses:
        "200":
          $ref: "#/components/responses/RSSessionSummary200"
        "400":
          $ref: "#/components/responses/RSSessionSummary400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /terms:
    get:
      summary: Get Terms And Conditions
      description: >
        This operation obtains terms and conditions in HTML format to be
        displayed in a web view.
      operationId: GetTermsAndConditions
      responses:
        "200":
          $ref: "#/components/responses/RSGetTermsAndConditions200"
        "400":
          $ref: "#/components/responses/RSGetTermsAndConditions400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
    post:
      summary: Accept Terms And Conditions
      description: |
        This operation allows to accept different legal elements such as:
        - Acceptance of terms and conditions
        - Declaration of being of legal age.
        - Receive marketing notifications.
      requestBody:
        $ref: "#/components/requestBodies/RQAcceptTermsAndConditions"
      operationId: AcceptTermsAndConditions
      responses:
        "200":
          $ref: "#/components/responses/RSAcceptTermsAndConditions200"
        "400":
          $ref: "#/components/responses/RSAcceptTermsAndConditions400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /payment:
    post:
      summary: Membership Payment
      description: >
        This operation allows to process the subscription payment using a
        card with e-commerce features.
      requestBody:
        $ref: "#/components/requestBodies/RQMembershipPayment"
      operationId: MembershipPayment
      responses:
        "200":
          $ref: "#/components/responses/RSMembershipPayment200"
        "400":
          $ref: "#/components/responses/RSMembershipPayment400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /personal/applicant:
    post:
      summary: Get Biometric Applicant Id
      description: >
        This operation generates a new biometric identifier (applicant-id)
        required to start the registration process and biometric validation of
        the individual customer. As a result, the operation generates a new
        applicant ID and a new URL so the biometric capture process can be
        started from the end customer's web and mobile channels.


        **Note:** The biometric registration process incorporates the registration of the identity documents of the end-customer.
      requestBody:
        $ref: "#/components/requestBodies/RQGetBiometricApplicantId"
      operationId: GetBiometricApplicantId
      responses:
        "200":
          $ref: "#/components/responses/RSGetBiometricApplicantId200"
        "400":
          $ref: "#/components/responses/RSGetBiometricApplicantId400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /personal/address:
    post:
      summary: Residence Address
      description: >
        This operation allows to save the information of the customer's
        home address.
      requestBody:
        $ref: "#/components/requestBodies/RQResidenceAddress"
      operationId: ResidenceAddress
      responses:
        "200":
          $ref: "#/components/responses/RSResidenceAddress200"
        "400":
          $ref: "#/components/responses/RSResidenceAddress400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /personal/info:
    post:
      summary: Personal Information
      description: >
        This operation allows to save the gender information, civil status,
        education level and any other field that complements the customer's
        personal information.
      requestBody:
        $ref: "#/components/requestBodies/RQPersonalInformation"
      operationId: PersonalInformation
      responses:
        "200":
          $ref: "#/components/responses/RSPersonalInformation200"
        "400":
          $ref: "#/components/responses/RSPersonalInformation400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/personal/otp/type/{typeId}":
    post:
      summary: OTP Request Via SMS Or E-mail
      description: >
        This operation requests a One Time Password (OTP) by SMS or e-mail
        to validate the cellphone number or email.
      requestBody:
        $ref: "#/components/requestBodies/RQOTPRequestViaSMSOrEmail"
      operationId: OTPRequestViaSMSOrEmail
      parameters:
        - $ref: "#/components/parameters/typeId"
      responses:
        "200":
          $ref: "#/components/responses/RSOTPRequestViaSMSOrEmail200"
        "400":
          $ref: "#/components/responses/RSOTPRequestViaSMSOrEmail400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/personal/otp/verify/{typeId}":
    post:
      summary: OTP Verification
      description: >
        This operation verifies the OTP sent and records the cell phone
        number or E-mail.
      requestBody:
        $ref: "#/components/requestBodies/RQOTPVerification"
      operationId: OTPVerification
      parameters:
        - $ref: "#/components/parameters/typeId"
      responses:
        "200":
          $ref: "#/components/responses/RSOTPVerification200"
        "400":
          $ref: "#/components/responses/RSOTPVerification400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /occupation/dependent:
    post:
      summary: Occupation
      description: >
        This operation allows to define and save the current occupation of
        the customer.
      requestBody:
        $ref: "#/components/requestBodies/RQOccupation"
      operationId: Occupation
      responses:
        "200":
          $ref: "#/components/responses/RSOccupation200"
        "400":
          $ref: "#/components/responses/RSOccupation400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /occupation/other:
    post:
      summary: Other Type Of Occupation
      description: >
        This operation allows to define and save an occupation other than
        student, independent and dependent.
      requestBody:
        $ref: "#/components/requestBodies/RQOtherTypeOfOccupation"
      operationId: OtherTypeOfOccupation
      responses:
        "200":
          $ref: "#/components/responses/RSOtherTypeOfOccupation200"
        "400":
          $ref: "#/components/responses/RSOtherTypeOfOccupation400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /income:
    post:
      summary: Income Source
      description: |
        This operation allows to specify the income of the customer.
      requestBody:
        $ref: "#/components/requestBodies/RQIncomeSource"
      operationId: IncomeSource
      responses:
        "200":
          $ref: "#/components/responses/RSIncomeSource200"
        "400":
          $ref: "#/components/responses/RSIncomeSource400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /expectedactivity:
    post:
      summary: Expected Account Activity
      description: >
        This operation allows to save the responses of the expected account
        activity, defined by the tenant.
      requestBody:
        $ref: "#/components/requestBodies/RQExpectedAccountActivity"
      operationId: ExpectedAccountActivity
      responses:
        "200":
          $ref: "#/components/responses/RSExpectedAccountActivity200"
        "400":
          $ref: "#/components/responses/RSExpectedAccountActivity400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /regulatoryassessment:
    post:
      summary: Regulatory Questions
      description: >
        This operation allows to save the answers to the questionnaire for
        regulatory questions, defined by the tenant.
      requestBody:
        $ref: "#/components/requestBodies/RQRegulatoryQuestions"
      operationId: RegulatoryQuestions
      responses:
        "200":
          $ref: "#/components/responses/RSRegulatoryQuestions200"
        "400":
          $ref: "#/components/responses/RSRegulatoryQuestions400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /documents:
    get:
      summary: Get Customer's Support Documents
      description: >
        This operation checks the list of documents required for the
        verification and support of the account, which is requested based on the
        responses of previous actions in the registration process and the
        parameterization stipulated by the tenant.
      operationId: GetCustomersSupportDocuments
      responses:
        "200":
          $ref: "#/components/responses/RSGetCustomersSupportDocuments200"
        "400":
          $ref: "#/components/responses/RSGetCustomersSupportDocuments400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
    post:
      summary: Upload Support Document
      description: >
        This operation allows to register the documents requested for the
        account verification.
      requestBody:
        $ref: "#/components/requestBodies/RQUploadSupportDocument"
      operationId: UploadSupportDocument
      responses:
        "200":
          $ref: "#/components/responses/RSUploadSupportDocument200"
        "400":
          $ref: "#/components/responses/RSUploadSupportDocument400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /usercreation:
    post:
      summary: User Creation
      description: >
        This operation allows to create user credentials, accompanied by
        the automatic approval request of the account. In case of presenting
        open escalations, the registration process will remain in a "Pending to
        Review" status, requesting manual approval of the team responsible for
        the tenant.
      requestBody:
        $ref: "#/components/requestBodies/RQUserCreation"
      operationId: UserCreation
      responses:
        "200":
          $ref: "#/components/responses/RSUserCreation200"
        "400":
          $ref: "#/components/responses/RSUserCreation400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/onboarding/decision":
    post:
      summary: Approve Account
      description: >
        This operation allows the approval or rejection of a registration
        request, resulting in the creation of an account or also the creation of
        a card, this will depend on the configuration have selected.
      requestBody:
        $ref: "#/components/requestBodies/RQApproveAccount"
      operationId: ApproveAccount
      parameters:
        - $ref: "#/components/parameters/customerId"
      responses:
        "200":
          $ref: "#/components/responses/RSApproveAccount200"
        "400":
          $ref: "#/components/responses/RSApproveAccount400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
security:
  - oAuth2ClientCredentials: []
components:
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      description: >
        See [Oauth2
        API](https://developer.novopayment.com/api/authentication-method-and-encryption/oauth2-api)
      flows:
        clientCredentials:
          tokenUrl: https://sandbox-api.novopayment.com/oauth2/token
          scopes: {}
  examples:
    HeaderParamsRequired:
      value:
        code: 400.25.001
        message: Header Params Required
        datetime: "2020-01-03T16:05:56.517Z"
    RequestParamsRequired:
      value:
        code: 400.25.003
        message: Params required
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidAccessToken:
      value:
        code: 401.25.990
        message: Invalid Access Token
        datetime: "2020-01-03T16:05:56.517Z"
    AccessTokenNotApproved:
      value:
        code: 401.25.991
        message: Access Token not approved
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidSignature:
      value:
        code: 401.25.992
        message: Invalid signature
        datetime: "2020-01-03T16:05:56.517Z"
    AccessTokenExpired:
      value:
        code: 401.25.993
        message: Access token expired
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidTenantId:
      value:
        code: 400.25.004
        message: Invalid tenant ID
        datetime: "2020-01-03T16:05:56.517Z"
    InternalServerError:
      value:
        code: 500.25.001
        message: Internal Server Error
        datetime: "2020-01-03T16:05:56.517Z"
    CustomerNotFound:
      value:
        code: 400.25.382
        message: Customer not found
        datetime: "2020-01-03T16:05:56.517Z"
    ParameterFormatError:
      value:
        code: 400.25.081
        message: Parameter format error
        datetime: "2020-01-03T16:05:56.517Z"
    OFACRecordFound:
      value:
        code: 400.25.108
        message: OFAC record found
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidData:
      value:
        code: 400.25.089
        message: Invalid data.
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidSessionParameters:
      value:
        code: 400.25.024
        message: Invalid session parameters.
        datetime: "2020-01-03T16:05:56.517Z"
    CardInformationInvalid:
      value:
        code: 400.25.046
        message: The payment could not be processed because of invalid card information.
        datetime: "2020-01-03T16:05:56.517Z"
    CardNumberInvalid:
      value:
        code: 400.25.047
        message: The card number is invalid.
        datetime: "2020-01-03T16:05:56.517Z"
    CardExpirationDateInvalid:
      value:
        code: 400.25.048
        message: Card expiration date is invalid.
        datetime: "2020-01-03T16:05:56.517Z"
    CardSecurityCodeInvalid:
      value:
        code: 400.25.049
        message: Card security code is invalid.
        datetime: "2020-01-03T16:05:56.517Z"
    ProcessNotCompleted:
      value:
        code: 400.25.019
        message: The process could not be completed.
        datetime: "2020-01-03T16:05:56.517Z"
    RegisteredUserWithThatEmail:
      value:
        code: 400.25.065
        message: There is already a registered user with that email.
        datetime: "2020-01-03T16:05:56.517Z"
    RegisteredUserWithThatCellNumber:
      value:
        code: 400.25.066
        message: There is already a registered user with that cell number.
        datetime: "2020-01-03T16:05:56.517Z"
    WrongCode:
      value:
        code: 400.25.384
        message: Wrong code, verify the data and try again.
        datetime: "2020-01-03T16:05:56.517Z"
    NumberAttemptsExceededWait:
      value:
        code: 400.25.388
        message: You have exceeded the number of attempts, wait 10 minutes and request a
          new one.
        datetime: "2020-01-03T16:05:56.517Z"
    NumberAttemptsExceeded:
      value:
        code: 400.25.389
        message: You have exceeded number of attempts, please request a new code.
        datetime: "2020-01-03T16:05:56.517Z"
    CodeExpired:
      value:
        code: 400.25.392
        message: Code expired, request a new code.
        datetime: "2020-01-03T16:05:56.517Z"
    RequestAcknowledgeFailure:
      value:
        code: 400.25.023
        message: It was not possible to acknowledge the request, please try again.
        datetime: "2020-01-03T16:05:56.517Z"
    AccountIsOnTheWay:
      value:
        code: 400.25.385
        message: Your account is on the way! We'll let you know when your account is
          ready.
        datetime: "2020-01-03T16:05:56.517Z"
    AccountCreate:
      value:
        code: 400.25.386
        message: Your account was created! You can now use your credentials to enter
          your account.
        datetime: "2020-01-03T16:05:56.517Z"
    CustomerStatusNotAllowed:
      value:
        code: 400.25.027
        message: Customer status is not allowed for this action.
        datetime: "2020-01-03T16:05:56.517Z"
    PersonalDataError:
      value:
        code: 400.25.028
        message: Personal data was not registered correctly.
        datetime: "2020-01-03T16:05:56.517Z"
    MainIdDocumentNotFound:
      value:
        code: 400.25.029
        message: Main ID document not found.
        datetime: "2020-01-03T16:05:56.517Z"
    PhoneNumberNotFound:
      value:
        code: 400.25.030
        message: Phone number not found.
        datetime: "2020-01-03T16:05:56.517Z"
    EmailNotFound:
      value:
        code: 400.25.031
        message: Email not found.
        datetime: "2020-01-03T16:05:56.517Z"
    AddressNotFound:
      value:
        code: 400.25.032
        message: Address not found.
        datetime: "2020-01-03T16:05:56.517Z"
    UserNotFound:
      value:
        code: 400.25.033
        message: User not found.
        datetime: "2020-01-03T16:05:56.517Z"
    IdDocumentDuplicated:
      value:
        code: 400.25.034
        message: ID document is duplicated.
        datetime: "2020-01-03T16:05:56.517Z"
    OpenEscalationsExist:
      value:
        code: 400.25.035
        message: Open escalations exist.
        datetime: "2020-01-03T16:05:56.517Z"
  parameters:
    customerId:
      name: customerId
      in: path
      description: Unique customer identifier.
      required: true
      schema:
        type: string
        example: 43DED66474E259FD
        maxLength: 40
    typeId:
      name: typeId
      in: path
      description: |
        OTP request type.

        **Possible values:**

          - sms
          - email
      required: true
      schema:
        type: string
        enum:
          - sms
          - email
  schemas:
    RQValidarDocId:
      type: object
      required:
        - documentNumber
      properties:
        documentNumber:
          type: string
          description: Identity document number.
          example: 24.288.239
          maxLength: 11
    RQDeviceRegistration:
      type: object
      required:
        - channelId
        - screenResolution
        - alias
        - model
        - timezone
        - gpsCountryId
        - networkOperator
        - pushToken
        - brand
        - osVersion
        - platform
        - simMcc
        - deviceId
      properties:
        androidId:
          type: string
          description: Identifier of the Android device sending the request.
          example: deOaGTS5co4
          maxLength: 38
        channelId:
          type: integer
          description: Device registration channel.
          example: 1
          maxLength: 38
        screenResolution:
          type: string
          description: Screen resolution of the device sending the request.
          example: 375x812
          maxLength: 10
        alias:
          type: string
          description: Device assigned name by the customer.
          example: 7A172B26D-EC90-442D-8425-CF225C4A4A934
          maxLength: 70
        model:
          type: string
          description: Mobile device model sending the request.
          example: iPhone12
          maxLength: 50
        timezone:
          type: string
          description: Time zone from where the request is sent.
          example: GMT-5
          maxLength: 50
        simMnc:
          type: integer
          description: Network code of the sim card’s device to be registered. Applies
            only to mobile apps.
          example: 123
          maxLength: 10
        simCountryId:
          type: integer
          description: Country identifier of the sim card. Applies only to mobile apps.
          example: 233
          maxLength: 38
        gpsCountryId:
          type: integer
          description: Country identifier of the device's GPS.
          example: 233
          maxLength: 38
        networkOperator:
          type: string
          description: Mobile operator of the device from which the service is consumed.
          example: T-mobile
          maxLength: 20
        pushToken:
          type: string
          description: Token generated by firebase that identifies each device to send
            notifications. Applies only to mobile apps.
          example: dzgIOgA1u_c:APA91bF9nQq8SiWd4Tf3q8U5Sb4EMu00DgA08Cq0EpOvElksQ-HZdlrgf8o8tgjH7IL_liXqRnnX3LBDOCHTDFp2HO4fwkPjtFEQWT0N4mt-rNTexFJSy26D1JskFELlYwMse6aBKxMt
          maxLength: 180
        brand:
          type: string
          description: Device brand that consumes the service.
          example: Apple
          maxLength: 50
        osVersion:
          type: string
          description: Operative system version.
          example: 13.3
          maxLength: 50
        platform:
          type: string
          description: Platform from where the service is consumed.
          example: iOS
          maxLength: 60
        simMcc:
          type: integer
          description: Country code of the sim card the device has. Applies only to mobile
            apps.
          example: 732
          maxLength: 38
        deviceId:
          type: string
          description: Device identifier of the operating system.
          example: 7A1722B6D-EC90-442D-8425-CF225C43AA934
          maxLength: 70
    RQTokenUpdate:
      type: object
      required:
        - pushToken
      properties:
        pushToken:
          type: string
          description: New token to register, exclusive to mobile apps.
          example: dzgIOgA1u_c:APA91bF9nQq8SiWd4Tf3q8U5Sb4EMu00DgA08Cq0EpOvElksQ-HZdlrgf8o8tgjH7IL_liXqRnnX3LBDOCHTDFp2HO4fwkPjtFEQWT0N4mt-rNTexFJSy26D1JskFELlYwMse6aBKxMt
          maxLength: 180
    RQSessionSummary:
      type: object
      required:
        - applicationOnboarding
        - digits
      properties:
        applicationOnboarding:
          type: string
          description: Unique code of the session previously created.
          example: VEDXLRU8YN
          maxLength: 6
        digits:
          type: string
          description: Last 4 digits of the card used to made the payment.
          example: 4427
          maxLength: 4
    RQAcceptTermsAndConditions:
      type: object
      required:
        - terms
        - legalAge
      properties:
        terms:
          type: boolean
          description: Acceptance of tems and conditions.
          enum:
            - true
            - false
        legalAge:
          type: boolean
          description: Acceptance of legal age.
          enum:
            - true
            - false
        marketingCampaigns:
          type: boolean
          description: Acceptance of receipt of campaign for marketing concept.
          enum:
            - true
            - false
    RQMembershipPayment:
      type: object
      required:
        - card
        - expirationDate
        - cardHolderName
        - securityCode
        - emailAddress
      properties:
        card:
          type: string
          description: Encrypted of card number with AES Encrypt. OTP Request Via SMS or
            E-mail.
          example: $ENCRYPTED_CARD$
          maxLength: 20
        expirationDate:
          type: string
          description: Encryption of card expiration date with AES Encrypt
          example: $ENCRYPTED_CARD$
          maxLength: 6
        cardHolderName:
          type: string
          description: Cardholder name.
          example: John Doe
          maxLength: 50
        securityCode:
          type: string
          description: Encrypted of card security code with AES Encrypt.
          example: $ENCRYPTED_CARD$
          maxLength: 4
        emailAddress:
          type: string
          description: Email to register the payment.
          example: JohnDoe@example.com
          maxLength: 20
    RQGetBiometricApplicantId:
      type: object
      required:
        - type
        - email
        - mobileNumber
      properties:
        type:
          type: string
          description: |
            Customer´s application type.

            Local: mobile

            Email and SMS: web
          example: SMS
          maxLength: 20
        email:
          type: string
          description: Email that receives the link.
          example: JohnDoe@example.com
          maxLength: 20
        mobileNumber:
          type: string
          description: Mobile number that receives the link.
          example: +1 6460000000
          maxLength: 20
    RQResidenceAddress:
      type: object
      required:
        - mainStreet
        - zipCode
        - homeNumber
        - addressTypeId
        - city
      properties:
        mainStreet:
          type: string
          description: Add

# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/novopayment/refs/heads/main/openapi/novopayment-onboarding-openapi.yml