NovoPayment Device API

The Device API from NovoPayment — 2 operation(s) for device.

GitHub OpenAPI

Operations 2

POST /device Device Registration #
POST /device/pushtoken Token Update #

Documentation

📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
Documentation
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0
📖
APIReference
https://developer.novopayment.com/api/digital-banking/onboarding-api-v1.0

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/novopayment:novopayment-device-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

novopayment-device-api-openapi.yml Raw ↑
openapi: 3.2.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 Device API
servers:
- description: Sandbox
  url: https://sandbox-api.novopayment.com/onboarding/v1
security:
- oAuth2ClientCredentials: []
tags:
- name: Device
paths:
  /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'
      tags:
      - Device
  /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'
      tags:
      - Device
components:
  examples:
    InvalidData:
      value:
        code: 400.25.089
        message: Invalid data.
        datetime: '2020-01-03T16:05:56.517Z'
    InternalServerError:
      value:
        code: 500.25.001
        message: Internal Server Error
        datetime: '2020-01-03T16:05:56.517Z'
    InvalidSignature:
      value:
        code: 401.25.992
        message: Invalid signature
        datetime: '2020-01-03T16:05:56.517Z'
    InvalidAccessToken:
      value:
        code: 401.25.990
        message: Invalid Access Token
        datetime: '2020-01-03T16:05:56.517Z'
    AccessTokenExpired:
      value:
        code: 401.25.993
        message: Access token expired
        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'
  responses:
    RSTokenUpdate400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSTokenUpdate400'
          examples:
            Invalid Data:
              $ref: '#/components/examples/InvalidData'
    RS401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RS401'
          examples:
            Invalid Access Token:
              $ref: '#/components/examples/InvalidAccessToken'
            Access Token Not Approved:
              $ref: '#/components/examples/AccessTokenNotApproved'
            Invalid Signature:
              $ref: '#/components/examples/InvalidSignature'
            Access Token Expired:
              $ref: '#/components/examples/AccessTokenExpired'
    RSDeviceRegistration200:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSDeviceRegistration200'
          examples:
            Success:
              value:
                code: 200.25.000
                message: Process Ok
                datetime: '2020-01-03T16:05:56.517Z'
    RS500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RS500'
          examples:
            Internal Server Error:
              $ref: '#/components/examples/InternalServerError'
    RSDeviceRegistration400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSDeviceRegistration400'
          examples:
            Invalid Data:
              $ref: '#/components/examples/InvalidData'
    RSTokenUpdate200:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSTokenUpdate200'
          examples:
            Success:
              value:
                code: 200.25.000
                message: Process Ok
                datetime: '2020-01-03T16:05:56.517Z'
  schemas:
    RSTokenUpdate200:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          description: Operation response code
          example: 200.25.000
          maxLength: 10
        message:
          type: string
          description: Response code description
          example: Process Ok
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
    RSDeviceRegistration200:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          description: Operation response code
          example: 200.25.000
          maxLength: 10
        message:
          type: string
          description: Response code description
          example: Process Ok
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
    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
    RS500:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 500.01.999
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          example: Internal Server Error
          description: Response code description
          maxLength: 140
        datetime:
          type: string
          example: '2020-01-03T16:05:56.517Z'
          description: Opertion Timestamp
          format: date-time
    RS401:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 401.01.990
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          example: Invalid Access Token
          description: Response code description
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
    RSTokenUpdate400:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 400.25.003
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          example: Params required
          description: Response code description
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
    RSDeviceRegistration400:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 400.25.003
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          example: Params required
          description: Response code description
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
    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
  requestBodies:
    RQTokenUpdate:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RQTokenUpdate'
      required: true
    RQDeviceRegistration:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RQDeviceRegistration'
      required: true
  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: {}
x-provenance:
  method: harvested
  publisher: NovoPayment
  source: https://dcrpi6aufyoyb.cloudfront.net/main/onboarding-api/onboarding-api-spec-v1.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)