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.
  version: v1
  title: Onboarding Occupation API
servers:
- description: Sandbox
  url: https://sandbox-api.novopayment.com/onboarding/v1
security:
- oAuth2ClientCredentials: []
tags:
- name: Occupation
paths:
  /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'
      tags:
      - Occupation
  /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'
      tags:
      - Occupation
components:
  responses:
    RSOccupation200:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSOccupation200'
          examples:
            Success:
              value:
                code: 200.25.000
                message: Process Ok
                datetime: '2020-01-03T16:05:56.517Z'
    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'
    RS500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RS500'
          examples:
            Internal Server Error:
              $ref: '#/components/examples/InternalServerError'
    RSOtherTypeOfOccupation200:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSOtherTypeOfOccupation200'
          examples:
            Success:
              value:
                code: 200.25.000
                message: Process Ok
                datetime: '2020-01-03T16:05:56.517Z'
    RSOtherTypeOfOccupation400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSOtherTypeOfOccupation400'
          examples:
            Process Not Completed:
              $ref: '#/components/examples/ProcessNotCompleted'
    RSOccupation400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSOccupation400'
          examples:
            Invalid Data:
              $ref: '#/components/examples/InvalidData'
  schemas:
    RSOtherTypeOfOccupation400:
      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
    RSOccupation200:
      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
    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
    RSOccupation400:
      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
    RQOccupation:
      type: object
      required:
      - occupationTypeId
      - startingDate
      - employer
      properties:
        occupationTypeId:
          type: integer
          description: Occupancy type ID.
          example: 1
          maxLength: 38
        startingDate:
          type: string
          description: Start date of work.
          example: 16-16-2019
        employer:
          type: object
          description: Object that identifies the employer.
          required:
          - employerName
          - industryTypeId
          - address
          properties:
            employerName:
              type: string
              description: Employer name.
              example: Novopayment SAS
              maxLength: 50
            industryTypeId:
              type: integer
              description: Type of industry that belongs to.
              example: 1
              maxLength: 38
            address:
              type: object
              description: Company address object.
              required:
              - mainStreet
              - zipCode
              - homeNumber
              - addressTypeId
              - city
              properties:
                mainStreet:
                  type: string
                  description: Address Line 1.
                  example: 20 W 34th St, New york
                  maxLength: 100
                complementaryInfo:
                  type: string
                  description: Address complement or line 2.
                  example: Edif. Novopayment
                  maxLength: 100
                zipCode:
                  type: string
                  description: Zip code.
                  example: 10011
                  maxLength: 10
                homeNumber:
                  type: string
                  description: House number.
                  example: 502
                  maxLength: 50
                buildingNumber:
                  type: string
                  description: Building or tower number.
                  example: 14
                  maxLength: 50
                addressTypeId:
                  type: string
                  description: Type of address.
                  example: 2
                  maxLength: 38
                city:
                  type: object
                  description: Address city object.
                  required:
                  - cityId
                  properties:
                    cityId:
                      type: integer
                      description: Address city identifier.
                      example: 918537
                      maxLength: 38
    RSOtherTypeOfOccupation200:
      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
    RQOtherTypeOfOccupation:
      type: object
      properties:
        occupationType:
          type: string
          description: 'Type of occupation.


            **Possible values:** self employed, student, other.

            '
          enum:
          - student
          - self employed
          - other
  requestBodies:
    RQOtherTypeOfOccupation:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RQOtherTypeOfOccupation'
      required: true
    RQOccupation:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RQOccupation'
      required: true
  examples:
    InvalidAccessToken:
      value:
        code: 401.25.990
        message: Invalid Access Token
        datetime: '2020-01-03T16:05:56.517Z'
    InvalidSignature:
      value:
        code: 401.25.992
        message: Invalid signature
        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'
    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'
    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'
  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: {}