Sign in

v1

latestOpenAPI 3.0.02026-07-2468247202.3 KB
KYC > Profile Management

Get user profile

Get user profile information by ID

get/verify/get_user_profile/{user_profile_id}

Path parameters

user_profile_idstring required

External user profile ID

Response

Successful operation

user_profile_idstring
first_namestring nullable
middle_namestring nullable
last_namestring nullable
second_last_namestring nullable
full_namestring nullable
date_of_birthstring

The person's date of birth in YYYY-MM-DD format

email_addressstring

The person's email address

phone_numberstring

The person's phone number. Prefer phone number in E.164 format

client_reference_idstring

An id you want to associate with the business profile.

client_reference_dataobject

A JSON you want to associate with the business profile.

verification_session_idsstring[]

List of verification sessions run against this User

user_profile_result'APPROVED' | 'DECLINED' | 'REVIEW' | 'UNKNOWN' | 'DEACTIVATED'

The result status for business/user profile APIs. Includes DEACTIVATED for deactivating profiles.

questions_responseobject

Questions responded by the business

events_callback_urlstring
created_atinteger
updated_atinteger