PaaS API Docs
  • Getting Started
  • Authentication
  • Use cases
    • Remittance
      • Bonus/Discount on Remittance
    • Business Payments
    • Individual Wallet
    • Business Wallet
    • Payout
  • API References
    • Data Population
      • Spec Sheet
      • Country
      • States
      • Settlement Rates
    • User
      • User Object
        • User Verification
        • Identification Documents
        • User Verification Status
        • CIP Information Status
      • Receive User Object
      • Register a User
      • Update User
      • Business Representatives
        • Business Representatives Object
        • Add Business Representatives
        • Update Business Representatives
        • Get Business Representatives
      • Declaration
        • Declaration Object
        • Declaration
      • Initiate Verification
      • Get User by ID
      • Get Verification Status
      • Add a Receive User
      • Update a Receive User
      • Get Receive User List
    • Funds
      • User Funding Account Object
      • Funding Account Widget
        • OAuth Integration
        • Bank Verification Status
      • Wallet Object
      • Create a Wallet
      • Get Wallet Details
      • Get User Funding Account
      • Delete User Funding Account
      • Add a Receive Account
      • Update a Receive Account
      • Get Receive Accounts
    • Payout
      • Get Banks
      • Get Payers
    • Transaction (External)
      • Transaction Object
      • Create Transaction
      • Get Transaction by ID
      • Cancel Transaction
      • Transaction Delivery
      • Get Transaction Limits
    • Transaction (Wallet)
      • Wallet Transfer Object
      • Create Transfers
        • Load Wallet
        • Unload Wallet
        • Wallet to Wallet Transfer
      • Get Wallet Transfer Details
      • Get Limits
    • Transaction (Payout)
      • Payout Transaction Object
      • Create Payout Transaction
    • Webhooks
      • Subscribe
      • Integration
      • Events
    • Error Codes
  • Sandbox
    • User: Test Values
    • Funds: Test Values
    • Transaction: Test Values
  • Changelog
    • 2023
      • February 14, 2023
      • January 06, 2023
    • 2022
      • December 28, 2022
      • December 26, 2022
      • December 23, 2022
      • December 2, 2022
      • November 21, 2022
      • November 11, 2022
      • October 31, 2022
      • October 17, 2022
      • August 31, 2022
      • August 1, 2022
      • July 25, 2022
      • May 23, 2022
      • April 7, 2022
      • March 30, 2022
      • March 23, 2022
      • Feb 21, 2022
      • Feb 15, 2022
      • Jan 24, 2022
      • Jan 19, 2022
      • March 10, 2022
Powered by GitBook
On this page

Was this helpful?

  1. API References
  2. User

Get Verification Status

Read on verification status of submitted user information

PreviousGet User by IDNextAdd a Receive User

Last updated 2 years ago

Was this helpful?

You can get the verification status of each KYC/KYB information (CIP tag) a user has submitted through this API. Only the status of submitted information will be presented here, however, you may be required to collect more information based on your spec sheet for a user's transaction to be processed.

The verification status can be any of the following. Details are also outlined .

Verification Status

Description

SUBMIT

CIP tag has been successfully submitted

REVIEWING

CIP tag is under review

VERIFIED

CIP tag is verified

FAILED

CIP tag verification failed

REQUESTED

CIP tag is required for the user. This usually occurs when a user has created a transaction above their current tier limits and additional KYC information is required to further process the transaction.

GET /users/{{user_id}}/cip-info

curl --location --request GET '{{url}}/users/{{user_id}}/cip-info' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json'

Individual user

{
	"cip_info": {
    	"GENDER": "VERIFIED",
    	"COUNTRY": "VERIFIED",
    	"STATE": "VERIFIED",
    	"LAST_NAME": "VERIFIED",
    	"OCCUPATION": "SUBMIT",
    	"CITY": "VERIFIED",
    	"ZIP_CODE": "VERIFIED",
    	"DATE_OF_BIRTH": "VERIFIED",
    	"ID_DOC": "VERIFIED",
    	"PHONE_NUMBER": "VERIFIED",
    	"EMAIL": "VERIFIED",
    	"ADDRESS_LINE1": "VERIFIED",
    	"MIDDLE_NAME": "SUBMIT",
    	"FIRST_NAME": "VERIFIED",
    	"IP_ADDRESS": "VERIFIED"
	},
	"kyc_status": "VERIFIED",
	"user_id": UUID
}

Business user

{
    "cip_info": {
        "NATURE_OF_BUSINESS": "VERIFIED",
        "COMPANY_TYPE": "VERIFIED",
        "EIN_NUMBER": "VERIFIED",
        "ACCOUNT_OPERATOR_INFO": "VERIFIED",
        "ZIP_CODE": "VERIFIED",
        "EMAIL": "VERIFIED",
        "CERTIFICATE_OF_INCORPORATION": "VERIFIED",
        "TXN_FREQUENCY": "VERIFIED",
        "NO_OF_EMPLOYEE": "VERIFIED",
        "DATE_OF_BIRTH": "VERIFIED",
        "EIN_DOC": "VERIFIED",
        "FIRST_NAME": "VERIFIED",
        "NO_OF_TXN_PER_MONTH": "VERIFIED",
        "MAILING_ADDRESS": "VERIFIED",
        "STATE": "VERIFIED",
        "SOURCE_OF_FUND": "VERIFIED",
        "ADDRESS_LINE1": "VERIFIED",
        "COUNTRY": "VERIFIED",
        "PHONE_NUMBER": "VERIFIED",
        "COMPANY_WEBSITE": "VERIFIED",
        "CITY": "VERIFIED"
    },
    "kyc_status": "VERIFIED",
    "user_id": {{UUID}}
}
here