API docs by Redocly

API Reference for ZIP Code and Digital Address (1.1.0.260723)

The Digital Address API provides features such as token issuance, ZIP Code* search, company-specific ZIP Code search, and Digital Address lookup.
*ZIP Code refers to Postal Code
*In this API, all response object keys are always returned. If a corresponding value does not exist, it will be returned as null.

searchcode

Common search for ZIP Code, Unique Corporate ZIP Code, and Digital Address

Code Number Search (1-1029)

Unified search endpoint for ZIP Code, Unique Corporate ZIP Code, and Digital Address.
Specify one option to perform a search and return address information.
When searching, specify the page number and the number of records to retrieve. If not specified, default values will be applied.

Parameters:

  • page:Page number (default:1)
  • limit: Maximum number of records to retrieve (default:1000, max:1000)
  • choikitype:Type of returned town field (If not specified, choikitype=1 is assumed)
    • 1:Without brackets
    • 2:With brackets
  • searchtype:Search target (If not specified, searchtype=1 is assumed)
    • 1:Search for ZIP Code, Unique Corporate ZIP Code, and Digital Address
    • 2:Search for ZIP Code and Digital Address
Authorizations:
token
path Parameters
search_code
required
string
  • ZIP Code (A ZIP Code with at least 3 digits. If the entered value is less than 7 digits, the system will search for data starting with the entered value.)
  • Unique Corporate ZIP Code
  • Digital Address
query Parameters
page
number

Page number (default:1)

limit
number

Maximum number of records to retrieve (default:1000, max:1000)

ec_uid
string

Provider's user ID (query parameter)

choikitype
number

Specify the fields to return (If not specified, choikitype=1 is assumed)

  • 1:Town Field without brackets
  • 2:Town Field with brackets
searchtype
number

Specify the Search Method (If not specified, searchtype=1 is assumed)

  • 1:Search for ZIP Code, Unique Corporate ZIP Code, and Digital Address
  • 2:Search for ZIP Code and Digital Address (Unique Corporate ZIP Code is excluded from the search)

Responses

Response samples

Content type
application/json
{
  • "addresses": [
    ],
  • "searchtype": "bizzipcode",
  • "limit": 10,
  • "count": 1,
  • "page": 1
}

addresszip

Search for Corresponding Address from Part of the Address

ZIP Code search by Address (1-1018/1-1019)

Search for the corresponding ZIP Code and address information from part of the address.

Authorizations:
token
query Parameters
ec_uid
string

Provider's user ID (query parameter)

Request Body schema: application/json
required
  • Returns the corresponding ZIP Code from the address
  • Returns data based on the matching level
  • Include the data type in the request. The applicable data types are as follows:
    • Code (e.g., pref_code)
    • Name (e.g., pref_name)
    • Katakana
    • Romanized letters
    • Free text
  • Notes on parameters:
    • You can specify the page number with the page parameter and the maximum number of records to retrieve with the limit parameter
    • If page and limit are omitted, default values (page=1, limit=1000) will be applied
    • If both pref_code and pref_name are requested, pref_code will take priority
    • If both city_code and city_name are requested, city_code will take priority
pref_code
string

Prefecture Code

pref_name
string

Prefecture Name

pref_kana
string

Prefecture Name (Kana)

pref_roma
string

Prefecture Name (Romanized)

city_code
string

City Code

city_name
string

City Name

city_kana
string

City Name (Kana)

city_roma
string

City Name (Romanized)

town_name
string

Town

town_kana
string

Town (Kana)

town_roma
string

Town (Romanized)

freeword
string

Free Word

flg_getcity
number

Flag for Retrieving City List Only (default:0, 0:Retrieve all information, 1:Retrieve city information only)

flg_getpref
number

Flag for Retrieving Prefecture List Only (default:0, 0:Retrieve all information, 1:Retrieve prefecture information only)

page
integer

Page Number (default:1)

limit
integer

Maximum Number of Records to Retrieve (default:1000, max:1000)

Responses

Request samples

Content type
application/json
Example

都道府県コードと市区町村コード

{
  • "pref_code": "13",
  • "city_code": "13102",
  • "flg_getcity": 0,
  • "flg_getpref": 0,
  • "page": 1,
  • "limit": 100
}

Response samples

Content type
application/json
{
  • "addresses": [
    ],
  • "level": 2,
  • "limit": 100,
  • "count": 2,
  • "page": 1
}

token

Retrieval of the necessary token for a business to use the Digital Address API

Obtaining the API Usage Token (1-1028)

Based on the grant_type of client_credentials in OAuth2.0, the API returns a usage token in response to the token request.
By specifying the client ID and secret key, which were obtained in advance through organization and system registration, a request is made. If the verification result is valid, a JWT-format token is returned.

header Parameters
x-forwarded-for
required
string

Source IP address

User-Agent
required
string

Client user agent string

Request Body schema: application/json
required
grant_type
required
string

grant_type (fixed as "client_credentials")

client_id
required
string

Client ID

secret_key
required
string

Secret Key

Responses

Request samples

Content type
application/json
{
  • "grant_type": "client_credentials",
  • "client_id": "TEST7t6fj7eqC5v6UDaHlpvvtesttest",
  • "secret_key": "testGzhSdzpZ1muyICtest0123456789"
}

Response samples

Content type
application/json
{
  • "scope": "J1",
  • "token_type": "jwt",
  • "expires_in": 123456,
  • "token": "{アクセストークン}"
}