> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voxo.co/llms.txt
> Use this file to discover all available pages before exploring further.

# CSR Lookup

> Perform a Customer Service Record lookup for a phone number



## OpenAPI

````yaml https://api.voxo.co/v2/docs/openapi.json post /v2/admin/number-porting/csr-lookup
openapi: 3.1.0
info:
  title: VOXO API
  description: VOXO Communication Platform API
  version: 2.0.0
servers:
  - url: https://api.voxo.co
security:
  - bearerAuth: []
paths:
  /v2/admin/number-porting/csr-lookup:
    post:
      tags:
        - Number Porting
      summary: CSR Lookup
      description: Perform a Customer Service Record lookup for a phone number
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                number:
                  description: Number
                  type: string
                  pattern: ^[1-9]\d{9}$
              required:
                - number
              additionalProperties: false
      responses:
        '200':
          description: CSR lookup result
          content:
            application/json:
              schema:
                type: object
                properties:
                  tn:
                    type: string
                    description: Telephone number
                  accountNum:
                    type: string
                    description: Account number
                  atn:
                    type: string
                    description: Account telephone number
                  endUser:
                    type: string
                    description: End user name
                  endUserAddress:
                    type: string
                    description: End user address
                  streetNum:
                    type: string
                    description: Street number
                  streetName:
                    type: string
                    description: Street name
                  streetType:
                    type: string
                    description: Street type (e.g. St, Ave)
                  streetPostDir:
                    type: string
                    description: Street direction ending (e.g. SW)
                  locationType1:
                    type: string
                    description: Location type 1 (e.g. Bld, Apt)
                  locationValue1:
                    type: string
                    description: Location value 1
                  locationType2:
                    type: string
                    description: Location type 2 (e.g. Flr, Ste)
                  locationValue2:
                    type: string
                    description: Location value 2
                  locationType3:
                    type: string
                    description: Location type 3
                  locationValue3:
                    type: string
                    description: Location value 3
                  city:
                    type: string
                    description: City
                  state:
                    type: string
                    description: State
                  postalCode:
                    type: string
                    description: Postal code
                  typeOfService:
                    type: string
                    description: Type of service (B/R)
                  serviceProvider:
                    type: string
                    description: Service provider
                  ocn:
                    type: string
                    description: Operating company number
                  numOfServiceLocations:
                    type: number
                    description: Number of service locations
                  numOfTnLines:
                    type: number
                    description: Number of telephone lines
                  authName:
                    type: string
                    description: Port-in authorizer name
                  authDate:
                    type: string
                    description: Port-in authorization date
                  earliestScheduledDate:
                    type: string
                    description: Earliest scheduled date
                  remarks:
                    type: string
                    description: Additional instructions
                  lsrRequirements:
                    type: string
                    description: LSR requirements
                  simplePort:
                    type: string
                    description: Simple port indicator (Y/N)
                  csrLookupMsg:
                    type: string
                    description: CSR lookup message
                  csrLookupResult:
                    type: number
                    description: CSR lookup result code
                  tnGroup:
                    type: array
                    items: {}
                    description: TN group
                required:
                  - tn
                  - accountNum
                  - atn
                  - endUser
                  - endUserAddress
                  - streetNum
                  - streetName
                  - streetType
                  - streetPostDir
                  - locationType1
                  - locationValue1
                  - locationType2
                  - locationValue2
                  - locationType3
                  - locationValue3
                  - city
                  - state
                  - postalCode
                  - typeOfService
                  - serviceProvider
                  - ocn
                  - numOfServiceLocations
                  - numOfTnLines
                  - authName
                  - authDate
                  - earliestScheduledDate
                  - remarks
                  - lsrRequirements
                  - simplePort
                  - csrLookupMsg
                  - csrLookupResult
                  - tnGroup
                additionalProperties: {}
        '400':
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  message:
                    type: string
                  code:
                    type: number
                  validationErrors:
                    type: array
                    items:
                      type: string
                required:
                  - name
                  - message
                  - code
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````