Skip to content

Get Account Status

GET https://connect.cabital.com/api/v1/partner/links/{user_ext_ref}

User Account Status

  • Linked
  • KYC Pass

Request Path Parameters

Parameter Required Description
user_ext_ref Yes Customer account ID provided by Partner.

Response Parameters

Parameter Type Description
account_uuid string Customer account ID provided by Cabital.
link_status string Current link status
  • LINKED: Already linked
  • UNLINKED: Already unlinked
otp_ready boolean Whether customer has already set OTP
email_address string User's email at Cabital
kyc_status integer User's KYC status at Cabital
  • 1: INIT Not yet submitted
  • 2: PENDING Already submitted, wait for reviewing
  • 3: PASS Already passed
  • 4: REJECT Already rejected
  • 5: REVIEW Under reviewing
account_status string Cabital account status
  • INITIALIZED: The customer has already linked, but the customer has not yet submitted KYC at Cabital.
  • PENDING: Cabital is processing customer's KYC materials.
  • TEMPORARY_REJECTED: The customer already requested to resubmit the KYC materials by Cabital.
  • FINAL_REJECTED: The customer has rejected to use Cabital service.
  • CREATED: The customer has passed the KYC, wait for partner to submit the KYC match.
  • MATCHED: The customer has matched the KYC successfully.
  • MISMATCHED: The customer failed to match the KYC.
  • UNLINKED: The customer or Cabital has unlinked with the partner's account.

Example

Request Data

curl "http://connect.cabital.com/api/v1/partner/links/cdaa9983-9b8f-4478-ba60-896ac239879d"

Response Data

{
  "account_uuid": "6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c",
  "link_status": "LINKED",
  "otp_ready": true,
  "email_address": "john.doe@email.com",
  "kyc_status": 3,
  "account_status": "MATCHING"
}