---
swagger: "2.0"
info:
  title: crds-cnf-d-organizations-branches
  description: This microservice will help to manage the information of one organization
    branch that belongs to an specific organization.
  version: 1.0.0
  x-ibm-name: crds-cnf-d-organizations-branches
host: 127.0.0.1
basePath: /api
schemes:
- https
produces:
- application/json
paths:
  /v1/cards/provisioning/organizations/branch:
    post:
      tags:
      - add-provisioning-organization-branch
      operationId: add-provisioning-organization-branch
      summary: 'LOB: TS&CO Container(OD&T); Feature: Add an organization branch that
        belongs to an organization or branch; Functionality: Add a new registera for
        a new organization branch.'
      description: This api helps to Add a new organization branch to an organization.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: addProvOrganizationBranchRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/AddProvOrganizationBranchRequest'
      responses:
        204:
          description: Successful operation.
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
    put:
      tags:
      - update-provisioning-organization-branch
      operationId: update-provisioning-organization-branch
      summary: 'LOB: TS&CO Container(OD&T); Feature: Modify an organization branch
        that belongs to an organization or branch; Functionality: Modify the registered
        data for the indicated organization branch.'
      description: This api helps to modify the registered data for the indicated
        organization branch.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: updateProvOrganizationBranchRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateProvOrganizationBranchRequest'
      responses:
        204:
          description: Successful operation.
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/cards/provisioning/organizations/branches/status:
    put:
      tags:
      - update-provisioning-organization-branch-status
      operationId: update-provisioning-organization-branch-status
      summary: 'LOB: TS&CO Container(OD&T); Feature: Delete an organization branch
        that belongs to an organization or branch; Functionality: Delete the registered
        data for the indicated organization branch.'
      description: This api helps to delete the registered data for the indicated
        organization branch.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: updateProvOrgBranchStatusRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateProvOrgBranchStatusRequest'
      responses:
        204:
          description: Successful operation.
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/cards/provisioning/organizations/branches/detail/retrieve:
    post:
      tags:
      - retrieve-provisioning-organization-branch-detail
      operationId: retrieve-provisioning-organization-branch-detail
      summary: 'LOB: TS&CO Container(OD&T); Feature: retrieve an organization branch
        that belongs to an organization ; Functionality: Retrieve the data for the
        indicated organization branch.'
      description: This API will retrieve the information of one organization branch
        that belongs to an specific organization
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: retrieveProvOrgBranchRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/RetrieveProvOrgBranchDetailRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveProvOrgBranchDetailResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/cards/provisioning/organizations/branches/retrieve:
    post:
      tags:
      - retrieve-provisioning-organization-branches
      operationId: retrieve-provisioning-organization-branches
      summary: 'LOB: TS&CO Container(OD&T); Feature: Retrieve all organization branches
        that belongs to an organization or branch; Functionality: Retrieve the registered
        data for the indicated organization branches.'
      description: This api helps to retrieve the registered data for all organization
        branches.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: retrieveProvOrgBranchesRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/RetrieveProvOrgBranchesRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveProvOrgBranchesResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  AddProvOrganizationBranchRequest:
    type: object
    properties:
      organizationBranch:
        $ref: '#/definitions/OrganizationBranch'
    required:
    - organizationBranch
  UpdateProvOrganizationBranchRequest:
    type: object
    properties:
      organizationBranch:
        $ref: '#/definitions/OrganizationBranch'
    required:
    - organizationBranch
  UpdateProvOrgBranchStatusRequest:
    type: object
    properties:
      organizationBranch:
        $ref: '#/definitions/OrganizationBranchData'
    required:
    - organizationBranch
  RetrieveProvOrgBranchDetailRequest:
    type: object
    properties:
      organizationBranch:
        $ref: '#/definitions/OrganizationBranchData'
    required:
    - organizationBranch
  RetrieveProvOrgBranchDetailResponse:
    type: object
    properties:
      organizationBranchName:
        description: Name of the branch that belongs to an organization where pre-registration
          request will be managed
        type: string
        example: DIVISION CENTRAL
        maxLength: 75
      requestTypeCode:
        description: Type of account opening request required by the organization.
        type: string
        example: "01"
        maxLength: 2
      organizationBranchStatusCode:
        description: Status of the UDT life cycles stages in the application.
        type: string
        example: "00"
        maxLength: 2
      sirh:
        description: SIRH of the branch that promoted the contract obtained by this
          web service
        type: string
        example: "001"
        maxLength: 4
      organizationBranchAdministrators:
        type: array
        minItems: 1
        maxItems: 2
        items:
          $ref: '#/definitions/Administrator'
      agent:
        $ref: '#/definitions/Agent'
      address:
        $ref: '#/definitions/Address'
    required:
    - sirh
    - organizationBranchName
    - requestTypeCode
    - organizationBranchStatusCode
    - organizationBranchAdministrators
    - agent
    - address
  RetrieveProvOrgBranchesRequest:
    type: object
    properties:
      organizationId:
        description: 'Identifier of the company that , as a customer, contracted the
          payroll card for its employees. Note: The company acts as an a intermediary
          for interbank electronic funds transfer (TEF) service such as the payroll
          card.'
        type: string
        example: "987654321012"
        maxLength: 16
      organizationBranchId:
        description: Identifier of the branch that belongs to an organization where
          pre-registration request will be managed
        type: string
        example: 000000000000468
        maxLength: 16
    required:
    - organizationId
  RetrieveProvOrgBranchesResponse:
    type: object
    properties:
      moreInformationIndicator:
        description: more information indicator
        type: string
        example: S
        maxLength: 1
      organizationBranches:
        type: array
        minItems: 0
        maxItems: 100
        items:
          $ref: '#/definitions/OrganizationBranchInformation'
    required:
    - moreInformationIndicator
    - organizationBranches
  OrganizationBranch:
    type: object
    properties:
      organizationId:
        description: 'Identifier of the company that , as a customer, contracted the
          payroll card for its employees. Note: The company acts as an a intermediary
          for interbank electronic funds transfer (TEF) service such as the payroll
          card.'
        type: string
        example: "987654321012"
        maxLength: 16
      organizationBranchId:
        description: Identifier of the branch that belongs to an organization where
          pre-registration request will be managed
        type: string
        example: 000000000000468
        maxLength: 16
      organizationBranchName:
        description: Name of the branch that belongs to an organization where pre-registration
          request will be managed
        type: string
        example: DIVISION CENTRAL
        maxLength: 75
      organizationBranchStatusCode:
        description: Status of the UDT life cycles stages in the application.
        type: string
        example: "00"
        maxLength: 2
      requestTypeCode:
        description: Type of account opening request required by the organization.
        type: string
        example: "01"
        maxLength: 2
      sirh:
        description: SIRH of the branch that promoted the contract obtained by this
          web service
        type: string
        example: "1523"
        maxLength: 4
      organizationBranchAdministrators:
        type: array
        minItems: 0
        maxItems: 2
        items:
          $ref: '#/definitions/Administrator'
      agent:
        $ref: '#/definitions/Agent'
      address:
        $ref: '#/definitions/Address'
    required:
    - organizationId
    - organizationBranchId
    - requestTypeCode
    - organizationBranchStatusCode
    - address
    - organizationBranchName
    - sirh
  OrganizationBranchInformation:
    type: object
    properties:
      organizationBranchId:
        description: Identifier of the branch that belongs to an organization where
          pre-registration request will be managed
        type: string
        example: "0000000000010"
        maxLength: 16
      sirh:
        description: SIRH of the branch that promoted the contract obtained by this
          web service
        type: string
        example: "0001"
        maxLength: 4
      organizationBranchName:
        description: Name of the branch that belongs to an organization where pre-registration
          request will be managed
        type: string
        example: walmart-polanco
        maxLength: 75
      administratorName:
        description: Name of the administrator of the UDT. Obtained for this service
        type: string
        example: Pedro Perez Garcia
        maxLength: 55
      payrollId:
        description: Payroll of the branch executive who promoted the contract obtained
          for this service
        type: string
        example: "000003532150"
        maxLength: 12
    required:
    - organizationBranchId
    - sirh
    - organizationBranchName
    - administratorName
    - payrollId
  OrganizationBranchData:
    type: object
    properties:
      organizationId:
        description: 'Identifier of the company that , as a customer, contracted the
          payroll card for its employees. Note: The company acts as an a intermediary
          for interbank electronic funds transfer (TEF) service such as the payroll
          card.'
        type: string
        example: "987654321012"
        maxLength: 16
      organizationBranchId:
        description: Identifier of the branch that belongs to an organization where
          pre-registration request will be managed
        type: string
        example: 000000000000468
        maxLength: 16
    required:
    - organizationId
    - organizationBranchId
  Administrator:
    type: object
    properties:
      fullName:
        description: Name of the administrator of the organization branch, Obtained
          for this service
        type: string
        example: JAVIER ROMERO PAZ
        maxLength: 55
      phoneNumber:
        description: Phone number of the organization branch, Obtained for this service
        type: string
        example: "55488596"
        maxLength: 10
      extensionNumber:
        description: Extension number of the organization branch, Obtained for this
          service
        type: string
        example: "00017"
        maxLength: 5
      faxNumber:
        description: Fax number of thte organization branch, Obtained for this service
        type: string
        example: "55455860"
        maxLength: 10
      emailAddress:
        description: E-mail address of the organization branch, Obtained for this
          service
        type: string
        example: jaropa@yahoo.com
        maxLength: 75
    required:
    - fullName
    - phoneNumber
  Agent:
    type: object
    properties:
      payrollId:
        description: Payroll of the branch executive who promoted the contract obtained
          for this service
        type: string
        example: "000003532150"
        maxLength: 12
      fullName:
        description: Name of the branch executive who promoted the contrac obtain
          though this web service
        type: string
        example: JAVIER ROMERO GOMEZ
        maxLength: 55
      phoneNumber:
        description: Phone number of the branch executive who promoted the contrac
          obtain though this web service
        type: string
        example: "55488596"
        maxLength: 10
      extensionNumber:
        description: Extension of the branch executive who promoted the contrac obtained
          for this service
        type: string
        example: "00017"
        maxLength: 5
      emailAddress:
        description: Email address of the branch executive who promoted the contrac
          obtain though this web service
        type: string
        example: jaropa@yahoo.com
        maxLength: 75
    required:
    - payrollId
    - fullName
    - phoneNumber
  Address:
    type: object
    properties:
      streetName:
        description: Street and address number of the organization branch
        type: string
        example: Benjamín Franklin 1256
        maxLength: 35
      colonyName:
        description: Neighborhood of domicile of the organization branch
        type: string
        example: Polanco
        maxLength: 25
      city:
        description: City, Delegation or population of the State of the republic of
          the UDT addres
        type: string
        example: Ciudad de México, Delegación Cuauhtémoc
        maxLength: 25
      stateName:
        description: State of the republic of the organization branch
        type: string
        example: Ciudad de México.
        maxLength: 25
      postalCode:
        description: Postal code of the organization branch address
        type: string
        example: "50000"
        maxLength: 5
    required:
    - streetName
    - colonyName
    - city
    - stateName
    - postalCode
  ErrorResponse:
    properties:
      type:
        type: string
        description: Invalid - Request did not confirm to the specification and was
          unprocessed and rejected. Please fix the value and try again
        enum:
        - error
        - warn
        - invalid
        - fatal
      code:
        description: Error code which qualifies the error
        type: string
      details:
        description: Human readable explanation specific to the occurrence of the
          problem
        type: string
      location:
        description: The name of the field that resulted in the error
        type: string
      moreInfo:
        description: URI to human readable documentation of the error
        type: string
      uuid:
        description: 128 bit UUID that you generate for every request
        type: string
      timestamp:
        description: timestamp of the error
        type: string
    required:
    - type
    - code
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
security:
- OAuth2 Application Flow:
  - /api/v1
  ClientID: []
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
  ClientID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...