API Documentation
All API
Service
Search for Member InformationSync
Version: v1
Version: v1
/api/v1/user/info
Request Headers
Request Parameters
Response Headers
X-KM-Correlation-Id
string
Required
Length : 20
Transaction number for tracking trasncription
- Form : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7digit, Hex String
X-KM-Crypto-Key-Id
string
Optional
Length : 32
Data encryption/decryption key ID
- Given ID from creating the service provider's project
- If it is passed as a callback, the first key issued among the keys issued to the service provider is used.
Response Parameters
userInfo
object
Required
Member information
aspId
string
Required
Length : 15
ASP ID
-ID assigned to a service provider
-ID is provided upon contract.
userId
number
Required
Min : 1 , Max : 9999999999999999999
Member ID
-Member's unique ID given when registering for membership
birthDate
string
Required
Length : 8
Member’s date of birth
-Format : yyyyMMdd
ci
string
Required
Length : 88
CI
-Connection Information
-Information to identify an individual when checking redundant register for service or linking with an external service can be obtained through mobile verification, etc.
-For service providers that do not need linking with external services, an ID is assigned to separate individual.
loginId
string
Required
Min : 1 , Max : 80
Member’s login ID
-Format of email address.
-Duplicate ID not allowed.
nationality
string
Required
Min : 6 , Max : 9
Member’s nationality
-Korean
-Foreigner
gender
string
Required
Min : 4 , Max : 6
Member’s gender
-Male
-Female
mobileNumber
string
Required
Min : 10 , Max : 20
Member’s mobile phone number
userName
string
Required
Min : 1 , Max : 100
Member’s name
string
Required
Min : 1 , Max : 50
(Member’s) email
joinChannel
string
Optional
Min : 1 , Max : 20
Service classification code
-Code for classifying services to which a member requested to register (e.g. OPENAPI, KONA, JADU, PINO, HEALTH)
addressInfo
object
Optional
Member’s address information
zipCode
string
Required
Min : 5 , Max : 6
Zip code
address
string
Required
Min : 1 , Max : 255
Address
addressDetail
string
Optional
Min : 1 , Max : 255
Address detail
status
string
Required
Min : 6 , Max : 20
Member status
-ACTIVE : Normal
-DELETED : Membership canceled
-SUSPENDED : Suspended
-DORMANCY : Dormant
-REGISTERED : In register step
-REJECT : Transaction rejected
Response Code
Detailed classification and addition of error for unseccessful withfrawal
200
Error code
000_000
Message
Success.
Description
Success
Test Data
Request
Response
Click Try It!
to start a Request and see the Response here!
