Verifik
Verifik
Verifik
  • Documentation
  • Accounts
    • Authentication
      • Email Authentication
      • Phone Authentication
      • Renew your token (JWT)
      • Create new token & revoke previous tokens
    • Clients
      • Account information
  • Services
    • SmartCheck
      • App Query example
    • SmartAccess
      • Dashboard
    • Access
      • Email Access Example
      • Phone Access Example
      • Biometric Access Example
    • SmartEnroll
    • Enroll
      • Tutorial
    • Smart Scan
  • Biometrics API's
    • Liveness
      • Liveness Detection
    • Compare
      • Compare & Liveness detection
      • Compare 1:1
    • Search
      • Search 1:N | Live
      • Search 1:N
      • Search 1:N | Crop
      • Face Detect
      • Face Verify
  • Scan Docs API's
    • Scan Studio
      • Documents supported
      • 🇨🇴[Example] Tarjeta de propiedad
    • Scan Prompt
      • Documents supported
      • Scan Prompt templates
  • Resources
    • Projects
      • The Project object
      • Create a project
      • Update a project
      • Retrieve a project
      • List all projects
    • Project Flows
      • The ProjectFlow object
      • Create a project flow
        • Login settings
        • Onboarding settings
        • Security settings
      • Update a project flow
      • Retrieve a project flow
      • List all project flows
    • App Logins
      • The AppLogin object
      • Create an app login
      • Retrieve an app login
      • List all app logins
    • App Registrations
      • The AppRegistration object
      • Create an app registration
      • Sync app registration status
      • Retrieve an app registration
      • List all app registrations
    • Credits
      • The Credit object
      • Retrieve a credit record
      • List all credit records
    • Document Validations
      • The DocumentValidation object
      • Enroll - Create Document Validation
      • Retrieve a document validation
      • List all document validations
      • Delete a document validation
    • Email Validations
      • The Email Validation object
      • Create Email Validation
      • Validate an Email Validation
      • Retrieve an Email Validation
      • List of Email Validations
    • Phone Validations
      • The Phone Validation object
      • Create Phone Validation
      • Validate Phone Validation
      • Retrieve a Phone Validation
      • List of Phone Validations
    • Collections
      • The Collection object
      • Create a Collection
      • Retrieve a Collection
      • List all Collection
    • Persons
      • The Person object
      • Create a Person
      • Create a Person [With Liveness detection]
      • Update a Person
      • Delete a Person
      • Retrieve a Person
      • List all Persons
    • Webhooks
      • The Webhook object
      • Create a Webhook
      • Update a Webhook
      • Delete a Webhook
      • Retrieve a Webhook
      • List all Webhooks
      • Webhook integration
    • Biometric Validations
      • The Biometric Validation Object
      • Create Biometric Validation
      • Validate Biometric Validation
      • Retrieve a Biometric Validation
      • List all Biometric Validations
  • Plans & Pricings
    • Database Screening plans
    • Smart Access Plans
      • Free Plans
      • Active Users
      • Sessions
      • Extra Charges
      • Enterprise Plans
    • SmartEnroll Plans
    • Enroll Plans
    • SMS/WhatsApp Pricing
  • Identity validation
    • 🇦🇷Argentina
    • 🇧🇴Bolivia
    • 🇧🇷Brazil
    • 🇨🇦Canada
      • 🇨🇦Ontario Driver license
      • 🇨🇦Quebec Driver license
      • 🇨🇦British Columbia license
    • 🇨🇱Chile
      • 🇨🇱Chilean taxpayer information
    • 🇨🇴Colombia
      • 🇨🇴Colombian Citizen
      • 🇨🇴Colombian Citizen with Extra Data
      • 🇨🇴Colombian Politically Exposed Persons
      • 🇨🇴Special Stay Permit (PEP) ID
      • 🇨🇴Colombian Foreigner ID (CE)
    • 🇨🇷Costa Rica
    • 🇩🇴Dominican Republic
    • 🇪🇨Ecuador
    • 🇸🇻El Salvador
    • 🇬🇹Guatemala
    • 🇭🇳Honduras
    • 🇲🇽Mexican
    • 🇵🇦Panama
    • 🇵🇾Paraguay
    • 🇵🇪Peru
      • 🇵🇪[v3] Peruvian Citizen
      • 🇵🇪[v3] Full Peruvian Citizen
      • 🇵🇪Peruvian Citizen
      • 🇵🇪Peruvian Foreigner Resident
      • 🇵🇪Peruvian Citizen Information with Extra Data
    • 🇪🇸Spain Citizen
    • 🇺🇸United States
      • 🇺🇸SSN Verification (Social Security Number)
      • 🇺🇸Florida Driver License Validation
      • 🇺🇸Kansas Driver's License Verification
    • 🇺🇾Uruguay
    • 🇻🇪Venezuela
      • 🇻🇪Venezuelan Citizen Information
      • 🇻🇪Venezuelan Foreigner citizens
  • Vehicle Validation
    • 🇦🇷Argentina
    • 🇧🇴Bolivia
    • 🇧🇷Brazil
    • 🇨🇱Chile
      • 🇨🇱Vehicle Information
      • 🇨🇱Driver license
    • 🇨🇴Colombia
      • 🇨🇴Vehicle by Code - Fasecolda
      • 🇨🇴SIMIT Resolutions
      • 🇨🇴Complete vehicle with historical records by VIN - RUNT
      • 🇨🇴Information System for Drivers Transporting Dangerous Goods
      • 🇨🇴Vehicle's SOAT and RTM by Plate and Identification document
      • 🇨🇴General query of SIMIT by license plate
      • 🇨🇴Driver's License
      • 🇨🇴Vehicle by plate and identification card only
      • 🇨🇴Vehicle Values by Plate - Fasecolda
      • 🇨🇴Verifik Pico y Placa for Bogotá
      • 🇨🇴Complete vehicle with historical records by plate and identification document - RUNT
      • 🇨🇴SIMIT Agreements
      • 🇨🇴SIMIT Fines
      • 🇨🇴General query of SIMIT by Identification Document
      • 🇨🇴Sinister Verification - Fasecolda
      • 🇨🇴Vehicle Fines Check in Bogotá, Colombia
      • 🇨🇴Taxes in Bogota
      • 🇨🇴Vehicle accidentality in Bogota
    • 🇨🇷Costa Rica
    • 🇪🇨Ecuador
      • 🇪🇨Ecuador Vehicle Fines
      • 🇪🇨Vehicle Information Lookup
    • 🇲🇽Mexico
    • 🇵🇾Paraguay
    • 🇵🇪Peru
      • 🇵🇪Peruvian Vehicle
      • 🇵🇪Peruvian Vehicle Insurance
    • 🇺🇸United States
      • 🇺🇸Vehicle Information
      • 🇺🇸Vehicle Information by VIN
  • Business Validation
    • 🇦🇷Argentina
    • 🇧🇴Bolivia
    • 🇧🇷Brazil
    • 🇨🇦Canada
    • 🇨🇱Chilean
    • 🇨🇴Colombia
      • 🇨🇴Colombian Business Information - RUES
      • 🇨🇴Complete Business Registry - RUES
      • 🇨🇴Colombian Company DIAN Verification
      • 🇨🇴Verify Legal Invoicer in DIAN for Colombian Companies
    • 🇨🇷Costa Rica
    • 🇲🇽Mexico
    • 🇵🇦Panama
    • 🇵🇾Paraguay
    • 🇵🇪Peru
    • 🇪🇸Spain
    • 🇺🇸United States
  • Background Check
    • 🇧🇷Brazil
    • 🇨🇴Colombia
      • 🇨🇴Public Contracts
      • 🇨🇴Colombian Police Record Check
      • 🇨🇴Verify Police Compliance with Corrective Measures
      • 🇨🇴Comptroller Certificate
      • 🇨🇴Disciplinary Records in Colombia (attorney's office)
    • 🌎International
      • 🌎Interpol Background Check
      • 🌎OFAC Background Check
      • 🌎Europol Background Check
      • 🌎FBI Background Check
      • 🌎ONU Background Check
      • 🌎DEA Background Check
  • Military
    • 🇨🇴Colombia
  • Finance
    • 🇨🇴Delinquent debtors
  • Legal
    • 🇨🇴Lawyer Verification
    • 🇨🇴Colombian Legal Processes
    • 🇨🇴Retrieve Details of a Legal Process by Number
    • 🇨🇴Court Case Records Lookup
    • 🇨🇴Certificate of Validity for Legal Professionals
  • Certificates
    • 🇨🇴Registry Certificate
    • 🇨🇴High Altitude Job Eligibility
    • 🇨🇴SENA Certificates
  • Voting
    • 🇨🇴Retrieve Voting Information for Colombian Citizens
  • Health
    • 🇨🇴Colombian RETHUS Verification Data
    • 🇨🇴Verify Colombian Affiliations
  • Verifik LLC
    • Privacy Policy
    • Políticas de Privacidad
    • Términos y Condiciones
    • Terms and Conditions
    • Acuerdo de Niveles de Servicio
    • Service Level Agreement
    • Verifik for Enterprises HUB (Esp)
    • Verifik for Enterprises HUB (Eng)
    • SmartCheck Terms and Conditions of Use
Powered by GitBook
On this page
  • Endpoint
  • Headers
  • Query Params
  • Request
  • Response
  1. Accounts
  2. Clients

Account information

Endpoint

https://api.verifik.co/v2/clients/me

With this service, you can bring your client information along with more information about your credits, subscription plan and the settings.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Query Params

Param
Value
Description

populates[]=

possible options clientSubscriptionPlan,

clientSubscriptionPlan.subscriptionPlan,

clientSettings.

With this option you could include populates to know more information linked to your client account.

Request

const axios = require('axios');
let data = JSON.stringify({
  "name": "New Project ABCDEF"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.verifik.co/v2/clients/me?populates[]=clientSubscriptionPlan.subscriptionPlan',
  headers: { 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer eyJhbGciOiJ9.eyJjbGllbnRJZCI6Ij...plt4Cw'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
curl --location 'https://api.verifik.co/v2/clients/me?populates[]=clientSubscriptionPlan.subscriptionPlan' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciXVCJ9.eyJjbGllb...splt4Cw' \
--data '{
    "name": "New Project ABCDEF"
}'
import requests

url = "https://api.verifik.co/v2/clients/me?populates[]=clientSubscriptionPlan.subscriptionPlan"

payload = {}
headers = {
  'Authorization': 'Bearer eyJhbGciOiJXVCJ9.eyJjbGllbnRJZCI...mLYvOSLuWixs'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Response

{
    "data": {
        "avatar": null,
        "initialIpAddress": null,
        "secretKey": null,
        "deletedAt": null,
        "_id": "613a3a48f2c84b454153add7",
        "active": true,
        "isEmailVerified": true,
        "isPhoneVerified": true,
        "isVerified": true,
        "otpSentAt": null,
        "requestsCount": 0,
        "subscriptionPlan": "61337217cbbb97a96877e984",
        "email": "jorgemanuel@verifik.co",
        "phone": "7809843183",
        "countryCode": "+1",
        "name": "JORGE MANUEL SANCHEZ",
        "updatedAt": "2025-03-12T17:37:13.526Z",
        "createdAt": "2021-09-09T16:46:01.334Z",
        "__v": 0,
        "totalRequestsCount": 1403,
        "credits": 114.03000000000034,
        "emailOTPCount": 0,
        "isBiometricVerified": false,
        "language": "es",
        "otp": "$2a$10$Q3wDasZgVWLuhEoYatVun.RBdItctOPNZ5lnXNWisZI0L.cFqM5b.",
        "phoneOTPCount": 0,
        "emailOTPSentAt": "2023-08-03T05:21:42.000Z",
        "status": "joined",
        "workSpace": "6647c29855503eb3e836449d",
        "clientSettings": "64cbd0717ae61d030ba39195",
        "JWTPhrase": "123456",
        "stripeCustomer": "cus_Q6iF3XDQgBQ8ZA",
        "clientSubscriptionPlan": {
            "projects": {
                "smartLinkLimit": 5,
                "smartAccessLimit": 5,
                "smartEnrollLimit": 5,
                "datAPILimit": 20,
                "globally": 20
            },
            "_id": "67c0d39dd4b3dec0fc4c81a7",
            "client": "613a3a48f2c84b454153add7",
            "name": "Plus",
            "subscriptionPlan": {
                "projects": {
                    "datAPILimit": 20,
                    "globally": 20,
                    "smartAccessLimit": 5,
                    "smartEnrollLimit": 5,
                    "smartLinkLimit": 5
                },
                "_id": "644f2a3ef19094d3b3f66b7f",
                "amount": 249,
                "changesInPrices": [
                    {
                        "group": "apiRequest",
                        "discount": 50,
                        "type": "percent"
                    },
                    {
                        "codes": [
                            "credit_intent"
                        ],
                        "type": "amount",
                        "discount": 0.4
                    },
                    {
                        "codes": [
                            "face_recognition_compare",
                            "face_recognition_verify",
                            "face_recognition_search_crops",
                            "face_recognition_detect",
                            "face_recognition_search"
                        ],
                        "type": "amount",
                        "discount": 0.02
                    },
                    {
                        "price": 0.8,
                        "code": "face_recognition_search_active_user"
                    },
                    {
                        "price": 0.24,
                        "code": "face_recognition_search_live_face"
                    },
                    {
                        "price": 0.24,
                        "code": "face_recognition_compare_live"
                    },
                    {
                        "price": 0.2,
                        "code": "face_recognition_liveness"
                    },
                    {
                        "baseCategory": "OCR",
                        "price": 0.05
                    },
                    {
                        "addOn": "documentBasicAntiFraud",
                        "active": true
                    },
                    {
                        "addOn": "chairs",
                        "count": 10
                    },
                    {
                        "addOn": "licenses",
                        "count": 2
                    },
                    {
                        "addOn": "whiteLabel",
                        "active": true
                    },
                    {
                        "addOn": "support",
                        "active": false
                    },
                    {
                        "addOn": "supportVIP",
                        "active": false
                    },
                    {
                        "addOn": "multipleRequests",
                        "active": false
                    },
                    {
                        "addOn": "dedicatedServer",
                        "active": false
                    }
                ],
                "trialDays": 0,
                "active": true,
                "visible": true,
                "visibleTo": null,
                "name": "Plus",
                "code": "smart_check_plus_plan",
                "limit": 100,
                "interval": "month",
                "intervalCount": 1,
                "currency": "USD",
                "stripeProduct": "prod_Nlo8FqIrzIfTkS",
                "stripePrice": "price_1N0GWgFO6i3ofqGHOOUioaUt",
                "__v": 1,
                "isSmartcheck": false,
                "createdAt": "2025-02-27T20:49:35.907Z",
                "lastUpdatedBy": "6601a41b68c04caf8a8464ac",
                "updatedAt": "2025-02-27T20:49:35.907Z"
            },
            "stripeSubscription": "sub_1QxEGqFO6i3ofqGH0fyDzHNJ",
            "category": "credits",
            "code": "smart_check_plus_plan",
            "interval": "month",
            "intervalCount": 1,
            "active": true,
            "lastFour": "4242",
            "cardBrand": "visa",
            "cardExpMonth": "2",
            "cardExpYear": "2027",
            "startDate": "2025-02-27T21:05:28.000Z",
            "endDate": "2025-03-27T21:05:28.000Z",
            "autoRenew": true,
            "notes": "new subscription -> sub_1QxEGqFO6i3ofqGH0fyDzHNJ",
            "updatedAt": "2025-02-27T21:05:33.107Z",
            "createdAt": "2025-02-27T21:05:33.107Z",
            "__v": 0
        },
        "person": null
    }
}
PreviousClientsNextSmartCheck

Last updated 1 month ago