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. Data Population

Spec Sheet

You can retrieve your CIP as per your spec sheet using this API. The details are based on the approved products for you. It contains the following information:

  1. Type of users configured for a Client (Individual and/or Business)

  2. Tiers configured for each type of user

  3. User's CIP information required for each tier

  4. Transaction limit for each tier, differentiated by type of transaction (EXTERNAL, LOAD, UNLOAD, TRANSFER)

  5. Wallet hold limit for each tier

The transaction limits are segregated into daily limit, monthly limit and annual limit. These limits will reset based on UTC time and not at the time when the user creates the transaction.

For example,

  • Daily limits for Mar 14 will be applicable from Mar 14 00:00:00 to 23:59:59 UTC and will reset on Mar 15 at 00:00:00 UTC

  • Monthly limits for March will be applicable from Mar 1 00:00:00 UTC to Mar 31 23:59:59 UTC

  • Annual limits for 2022 will be applicable from Jan 1 2022 00:00:00 UTC to Dec 31 2022 23:59:59 UTC

The CIP tags for a tier level represent the user’s KYC information required in that tier level and is cummulative of all the CIP tags of that tier and all the tiers below it. For example, for Tier 3 user, all the CIP tags of Tier 1, Tier 2 and Tier 3 will be required.

Please note that even if all the required KYC/KYB information for a specific limit is not collected and verified for a particular user, they can still conduct a transactions of that limit. However, the transaction will be placed on HOLD until the required information is submitted and verified.

GET /cip-info

curl --location --request GET '{{url}}/cip-info' \
--header 'X-Client-Id:{{client_id}} ' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json'
{
    "destinations": [
        {
            "country": "Test Country",
            "individual": {
                "cip_infos": [
                    {
                        "cip_tags": [
                            "ADDRESS_LINE1",
                            "CITY",
                            "COUNTRY",
                            "ZIP_CODE",
                            "GENDER",
                            "STATE",
                            "LAST_NAME",
                            "EMAIL",
                            "PHONE_NUMBER",
                            "DATE_OF_BIRTH",
                            "FIRST_NAME"
                        ],
                        "tier": 1,
                        "transaction_limit": {
                            "annual_limit": "10000",
                            "daily_limit": "200",
                            "monthly_limit": "5000"
                        },
                        "type": "EXTERNAL"
                    },
                    {
                        "cip_tags": [
                            "ADDRESS_LINE1",
                            "CITY",
                            "COUNTRY",
                            "ZIP_CODE",
                            "GENDER",
                            "STATE",
                            "LAST_NAME",
                            "EMAIL",
                            "PHONE_NUMBER",
                            "DATE_OF_BIRTH",
                            "FIRST_NAME"
                        ],
                        "tier": 1,
                        "transaction_limit": {
                            "annual_limit": "10000",
                            "daily_limit": "200",
                            "monthly_limit": "5000",
                            "max_wallet_hold_limit":5000
                        },
                        "type": "TRANSFER"
                    },
                    {
                        "cip_tags": [
                            "ADDRESS_LINE1",
                            "CITY",
                            "COUNTRY",
                            "ZIP_CODE",
                            "GENDER",
                            "STATE",
                            "LAST_NAME",
                            "EMAIL",
                            "PHONE_NUMBER",
                            "DATE_OF_BIRTH",
                            "FIRST_NAME"
                        ],
                        "tier": 1,
                        "transaction_limit": {
                            "annual_limit": "10000",
                            "daily_limit": "10",
                            "monthly_limit": "5000",
                            "max_wallet_hold_limit":5000
                        },
                        "type": "UNLOAD"
                    },
                    {
                        "cip_tags": [
                            "ADDRESS_LINE1",
                            "CITY",
                            "COUNTRY",
                            "ZIP_CODE",
                            "GENDER",
                            "STATE",
                            "LAST_NAME",
                            "EMAIL",
                            "PHONE_NUMBER",
                            "DATE_OF_BIRTH",
                            "FIRST_NAME"
                        ],
                        "tier": 1,
                        "transaction_limit": {
                            "annual_limit": "10000",
                            "daily_limit": "200",
                            "monthly_limit": "5000",
                            "max_wallet_hold_limit":5000
                        },
                        "type": "LOAD"
                    },
                    {
                        "cip_tags": [
                            "ID_NUMBER",
                            "ID_ISSUING_AUTHORITY",
                            "ID_DOC",
                            "ID_EXPIRY_DATE"
                        ],
                        "tier": 2,
                        "transaction_limit": {
                            "annual_limit": "10000",
                            "daily_limit": "2000",
                            "monthly_limit": "5000",
                            "max_wallet_hold_limit":5000
                        },
                        "type": "TRANSFER"
                    },
                    {
                        "cip_tags": [
                            "ID_NUMBER",
                            "ID_ISSUING_AUTHORITY",
                            "ID_DOC",
                            "ID_EXPIRY_DATE"
                        ],
                        "tier": 2,
                        "transaction_limit": {
                            "annual_limit": "10000",
                            "daily_limit": "2000",
                            "monthly_limit": "5000",
                            "max_wallet_hold_limit":5000
                        },
                        "type": "LOAD"
                    },
                    {
                        "cip_tags": [
                            "ID_NUMBER",
                            "ID_ISSUING_AUTHORITY",
                            "ID_DOC",
                            "ID_EXPIRY_DATE"
                        ],
                        "tier": 2,
                        "transaction_limit": {
                            "annual_limit": "10000",
                            "daily_limit": "2000",
                            "monthly_limit": "5000",
                            "max_wallet_hold_limit":5000
                        },
                        "type": "UNLOAD"
                    },
                    {
                        "cip_tags": [
                            "ID_NUMBER",
                            "ID_ISSUING_AUTHORITY",
                            "ID_DOC",
                            "ID_EXPIRY_DATE"
                        ],
                        "tier": 2,
                        "transaction_limit": {
                            "annual_limit": "12000",
                            "daily_limit": "500",
                            "monthly_limit": "10000"
                        },
                        "type": "EXTERNAL"
                    },
                    {
                        "cip_tags": [
                            "FULL_SSN"
                        ],
                        "tier": 3,
                        "transaction_limit": {
                            "annual_limit": "120000",
                            "daily_limit": "10000",
                            "monthly_limit": "10000"
                        },
                        "type": "EXTERNAL"
                    }
                ]
            }
        }
    ],
    "paging": {
        "page": 1,
        "page_size": 20,
        "total_count": 1
    }
}
PreviousData PopulationNextCountry

Last updated 2 years ago

Was this helpful?