@eyedea-sockets/brreg/socket.yml

Integration with The Brønnøysund Register Centre API

name: brreg
description: Integration with The Brønnøysund Register Centre API
runtime: nodejs_v8
endpoints:
  check-name:
    description: Check if the given company name exist
    inputs:
      properties:
        name:
          type: string
          description: Name of the company to check
          example: Eyedea AS
    outputs:
      success:
        description: Success
        properties:
          exist:
            type: bool
            description: Param which indicates if company exist or not
      fail:
        exit_code: 400
        description: Failed
        properties:
          msg:
            type: bool
            description: Error message
  get:
    description: Get company by org number
    inputs:
      properties:
        orgNumber:
          type: number
          description: Org. number of the company to get
          example: 98293120821
    outputs:
      success:
        description: Success
        properties:
          orgNumber:
            type: number
          name:
            type: string
          address:
            properties:
              address:
                type: string
              postNumber:
                type: string
              city:
                type: string
      fail:
        description: Fail
        properties:
          message:
            description: Fail message
            type: string