사업자 검색

POST 
/bizno/v1/biz/search

요청한 조건에 해당하는 사업자를 찾습니다

Request

application/json

Body

required

query stringrequired

검색할 문자열

attributes string[]

Default value: bizName,ceoName

(Optional) 검색할 속성: "bizName" 상호, "ceoName" 대표자명

limit number

Possible values: <= 1000

Default value: 10

(Optional) 검색결과 출력크기

Responses

200

application/json

Schema

Schema

totalCount number

전체 검색 결과 수 (최대 10,000건 까지 출력)

nondisclosureCount number

응답 내 정보공개거부(해당 사업자 요청) 등으로 제외된 결과 수

list

object[]

검색 결과

Array [

bizNo string

사업자등록번호

bizName string

상호

ceoName string

대표자명

zipCode string

우편번호

shortAddress string

주소 (부분출력)

]

Example (from schema)

{
  "totalCount": 0,
  "nondisclosureCount": 0,
  "list": [
    {
      "bizNo": "string",
      "bizName": "string",
      "ceoName": "string",
      "zipCode": "string",
      "shortAddress": "string"
    }
  ]
}

400

입력내용 검증오류

application/json

Schema

Schema

errorId string

오류 식별자

error string

오류 유형

message string

오류 메시지

Example (from schema)

{
  "errorId": "string",
  "error": "Internal Server Error",
  "message": "서버에서 오류가 발생했습니다"
}

401

유효하지 않은 토큰을 사용한 경우

application/json

Schema

Schema

errorId string

오류 식별자

error string

오류 유형

message string

오류 메시지

Example (from schema)

{
  "errorId": "string",
  "error": "Internal Server Error",
  "message": "서버에서 오류가 발생했습니다"
}

500

연계기관 오류, 내부서버 오류 발생시

application/json

Schema

Schema

errorId string

오류 식별자

error string

오류 유형

message string

오류 메시지

Example (from schema)

{
  "errorId": "string",
  "error": "Internal Server Error",
  "message": "서버에서 오류가 발생했습니다"
}

Loading...