Ad account management

This document describes how to use the Ad account management API.

View business information

Basic information

Method	URL	Authorization
GET	https://apis.moment.kakao.com/openapi/v4/companies	Business token

Permission	Prerequisite	Business Authentication	Business consent items
Required: Request permission	Switch to a Biz app Set Business redirect URI Business consent items	Required	Required

This API enables you to retrieve business information.

Send a GET request with the issued Business token and an ad account ID (adAccountId) in the request header. You must also pass the business registration number of a company to be retrieved. If the request is successful, this API returns the detailed information of the requested company in JSON format. If failed, refer to Error code to figure out its failure cause.

Request

Header

Name	Description	Required
Authorization	Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} Business token as a type of user authentication.	O
adAccountId	adAccountId: ${AD_ACCOUNT_ID} Ad account's ID.	O

Query parameter

Name	Type	Description	Required
bizNum	String	Business registration number.	O

Response

Body

Name	Type	Description
id	Long	Company's ID.
businessRegistrationNumber	String	Business registration number.
name	String	Company's name.
representationName	String	Company's representative.
address	Address	Company's address.
businessCategory	String	Type of business.
businessItem	String	Item of business.

Address

Name	Type	Description
baseAddress	String	Base address.
detailAddress	String	Detailed address.
zipCode	String	Zip code.

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/companies?bizNum=120-81-47521" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"

Response

{
    "id": 680,
    "businessRegistrationNumber": "123-12-12345",
    "name": "company name",
    "representationName": "company representative name",
    "businessCategory": "business type",
    "businessItem": "business item",
    "address": {
        "zipCode": "13494",
        "baseAddress": "경기 성남시 분당구 판교역로 235",
        "detailAddress": "H스퀘어"
    }
}

See more

• Kakao Moment API Reference