{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"07de3b33-dfc0-49cf-8c7d-7e0e9b7a80a5","name":"White label API (v2.0)","description":"In order to use White label public API, user will have to go through few simple steps:\n\n- API key and API secret\n- HMAC authorization header\n    \n\n<h4>API key and API secret</h4>\n\nTo use Verifo Public API, user will need to obtain API key and secret, which are passed to Verifo Public API with every request.  \nIn order to obtain API key and secret, please contact Verifo support.\n\n<h4>HMAC authorization header</h4>\n\nOnce user obtained API key and secret, it is all set up! Now, the only thing left is to form HMAC Authorization header. HMAC Authorization header is formed like this:\n\n**Authorization: VERSION+'-HMAC-SHA512 Key='+CLIENT_KEY+',Signature='+HmacSHA512(queryString+'|'+bodyString, SECRET_KEY)**\n\nTo generate HMAC header, follow these simple steps:\n\n1. Append query parameters as a string with '|' (pipe) and append body parameters as a string (queryString|bodyString).\n2. Encode the result by HmacSHA512 with secret, which is API secret provided by Verifo support.\n3. Finally, insert the result from step 2 and other variables into formula provided on top. Don't forget to add your API key provided by Verifo support, and API version (uppercase), which is currently '{{version}}'.\n    \n\n```\nNext, we will show how to retrieve body and query strings.  \n\n ```\n\nvar CLIENT_KEY = client_api_key; // key obtained from Verifo support  \nvar SECRET_KEY = client_api_secret; // secret obtained from Verifo support  \nvar VERSION = postman.getEnvironmentVariable('version').toUpperCase(); // version of API, provided with environment variables  \nvar TIMESTAMP = Math.floor(Date.now() / 1000) + 6; // timestamp in seconds  \nvar NONCE = Math.floor((Date.now() + Math.random()) \\* 100); // unique nonce (unique request id)\n\n```\n**bodyString** - simply take whole request body as a string. if there is no body, or it is empty, treat bodyString as ''.  \n**queryString** - query string consists of everything except domain. '/api/' prefix, version, and path, also all parameters from request url separated by '&' sign (for example: 'limit=10&nonce=12345678945'). query string should never be empty  \n\n ```\n\nvar message = queryString + '|' + bodyString; // merge parameters from url and body\n\n```\nTake message and encode it with HmacSHA512 using SECRET_KEY:  \n\n ```\n\nvar hmacDigest = CryptoJS.enc.Hex.stringify(CryptoJS.HmacSHA512(message, SECRET_KEY));\n\n```\nFinally, put all of the variables together to form HMAC authorization header:  \n\n ```\n\nvar headerValue = VERSION+'-HMAC-SHA512 Key='+CLIENT_KEY+',Signature='+hmacDigest;\n\n```\n**That's it! User can now use 'headerValue' variable value for Authorization header to communicate with Verifo Public API.**  \n---\n_Here is the complete example of HMAC authorization header in JS (it is included in Postman Pre-request scripts, so this API is ready to use out of the box):  \n_\n\n ```\n\n``` javascript\nfunction getQueryString(url, variables, HOST) {\n    for (let variable in variables) {\n        url = url.replace('{{' + variable + '}}', variables[variable]);\n    }\n    return url.replace(HOST,'');\n}\nfunction getBodyString(data, variables) {\n    for (let variable in variables) {\n        data = data.replace('{{' + variable +'}}', variables[variable]);\n    }\n    obj = JSON.parse(data);\n    if (Object.keys(obj).length === 0) {\n        return '';\n    } else {\n        return data;\n    }\n}\nfunction getNonce() {\n  return Math.floor((Date.now() + Math.random()) * 100);\n}\nfunction getTimestamp() {\n  return Math.floor(Date.now() / 1000) + 6;\n}\nfunction getHmacHash(request, postman) {\n    let CLIENT_KEY = postman.getEnvironmentVariable('apiKey');\n    let SECRET_KEY = postman.getEnvironmentVariable('apiSecret');\n    let VERSION = postman.getEnvironmentVariable('version').toUpperCase();\n    let HOST = postman.getEnvironmentVariable('host');\n    postman.setEnvironmentVariable('timestamp', getTimestamp());\n    postman.setEnvironmentVariable('nonce', getNonce());\n    let variables = postman.__environment;\n    let queryString = getQueryString(request['url'], variables, HOST);\n    postman.setEnvironmentVariable('queryParams', queryString);\n    let bodyString = '';\n    if (request['data'] && request['data'].length) {\n        bodyString = getBodyString(request['data'], variables);\n    }\n    postman.setEnvironmentVariable('bodyParams', bodyString);\n    let message = queryString+'|'+bodyString;\n    let hmacDigest = CryptoJS.enc.Hex.stringify(CryptoJS.HmacSHA512(message, SECRET_KEY));\n    let headerValue = VERSION+'-HMAC-SHA512 Key='+CLIENT_KEY+',Signature='+hmacDigest;\n    return headerValue;\n}\npostman.setEnvironmentVariable('hmacAuthHeader', getHmacHash(request, postman));\n\n ```\n\n# Change Log\n\n| Version | Date | Updates |\n| --- | --- | --- |\n| 2.0.17 | 2025-09-25 | Added endpoints to verify if beneficiary is owner of account number [Payee Verification](#c1f5ac44-d2f7-4996-b92f-67b79cb62d17). Added **payeeVerificationId** property to transaction. Create transaction (SEPA/INTERNAL). |\n| 2.0.16 | 2025-06-18 | Added **Change Policy** |\n| 2.0.16 | 2025-01-06 | Added integration to take client data from third party providers. [Accept data from third party](#65c09d36-03ce-44ac-91a4-88918c42af70). Added **vatNumber** property to person profile. [Get profiles (Person)](#9a6107ba-d9dd-4a92-9ff5-816a00b1f45b). [Create profile (Person)](#55f985d4-8bbb-479e-a980-ce11ae35b14f). [Update profile (Person)](#e2877392-5693-4947-a067-9e6aee395253). |\n| 2.0.15 | 2024-09-11 | Added **\"block\"** property to **walletCurrencyList**. |\n| 2.0.14 | 2024-06-06 | Added integration to take client data from third party providers. [Accept data from third party](#6591848e-ad3c-48d0-b6a6-7ab4d9eeddd7). |\n| 2.0.13 | 2024-02-15 | Updated identity endpoint file request length. [Add identity (Person)](#52c52102-73a7-4dd8-ba97-a211bb5381d9), [PUT Update identity (Person)](#aa12dd71-5754-492b-a6ec-2319125ddd69). |\n| 2.0.12 | 2024-02-06 | Added prfile page endpoints. [Get profiles (Person)](#9a6107ba-d9dd-4a92-9ff5-816a00b1f45b), [Get profiles (Company)](#f78d90a1-94ee-496e-8a8b-09065681b0e2). |\n| 2.0.11 | 2024-02-01 | Added \"**riskStatus**\" property to person and company objects. Added risk status [Risk status event](#523c4b89-e13b-4e26-8777-0f4c1263af03). |\n| 2.0.10 | 2023-12-27 | Added **Customer agreement** endpoints. |\n| 2.0.9 | 2023-12-27 | Increased company name length. [Create profile (Company)](#3e4bdf37-7281-42cd-9aae-c1953935ae3e), [Update profile (Company)](#8db7e31e-1e36-4ee4-b3ed-2517ddd80667). |\n| 2.0.8 | 2023-12-05 | Added webhook for triggered rules [Rule triggered event](#e23a386b-2196-464d-bbb0-e739aef9dce0). |\n| 2.0.7 | 2023-12-04 | Added refund transaction endpoint [Refund transaction](#b6d8d823-3f59-4d6a-a744-e9ccf158808c). |\n| 2.0.6 | 2023-12-04 | Added update endpoints. [Update profile (Person)](#e2877392-5693-4947-a067-9e6aee395253), [Update profile (Company)](#8db7e31e-1e36-4ee4-b3ed-2517ddd80667), [Update address](#a3f47a07-124d-4483-b464-c0f94f0edf1c), [Update identity (Person)](#aa12dd71-5754-492b-a6ec-2319125ddd69), [Update questionnaire (Person)](#127cc3b1-540d-4baf-91fb-5e90b9da2aca), [Update questionnaire (Company)](#f75d4594-f1d0-425e-a715-a83b458af953). Can update infromacion with already existing endpoints [Add company relation](#5589c60b-e81d-41d0-81f6-0ccb6a49de62), [Delete company relation](#b3a30dee-1d21-45d7-a064-34212f8396b8), [Add/Update proof of address (Person)](#260410da-9cec-41b0-be0f-5485b432f5fe), [Add/Update documents (Company)](#136778e1-891a-4420-a8ee-058f7f231d84), [Add/Update document (Person, Company)](#39ab5224-8904-4d70-93d2-e28e8f9b714e). |\n| 2.0.5 | 2023-08-14 | Removed transaction statuses **unapproved** and **frozen** |\n| 2.0.4 | 2023-03-31 | Added **suspended** account status |\n| 2.0.3 | 2023-02-20 | Implemented **Lite KYC** scenario. |\n| 2.0.2 | 2023-01-18 | **CHANGED PERSON/COMPANY QUESTIONNAIRE STRUCTURE**. From API version v1.1 removed **QUESTIONNAIRE** object.  <br>  <br>a) Person questionnaires changed **occupation** types;  <br>b) Person questionnaires added **companyPosition** property to occupation object;  <br>c) Person questionnaires added **sourceOfIncome**;  <br>d) Person/Company questionnaires changed **turnovers** structure. Added cash outgoing property. Turnovers now required number value instead of enum;  <br>e) Person questionnaires changed **typeOfPayments** types;  <br>f) Company questionnaires changed **accountInfoUse**, **accountInfoScope** types and structure. Properties moved to questionnaire object;  <br>g) Company questionnaires added **countriesFundsOriginateFrom** and **countriesFundsOriginateTo** properties;  <br>h) Company questionnaires added **businessActivies** and removed **companyActivity** properties. |\n| 2.0.1 | 2022-12-06 | Added cards endpoints |\n| 2.0.0 | 2022-09-23 | Released version v2.0.0 |\n\n# Change Policy\n\n## Purpose\n\nThis policy outlines the procedures and guidelines for managing changes to Application Programming Interfaces (APIs) developed and maintained by UAB Verified Payments. The goal is to ensure stability, backward compatibility and clear communication to API clients.\n\n## Versioning Strategy\n\nAll API changes are categorized into breaking or non-breaking changes. We make every effort to implement changes as non-breaking, and do not generally notify clients about non-breaking changes. However, there are situations that may require breaking changes, for such cases clients will be contacted with necessary information.\n\n## Change Categories\n\n### **Breaking changes**\n\n- Removal of API or functionality\n- Removal of property from the request (even if they are considered optional)\n- Addition of new mandatory property to the request\n- Addition of new mandatory query parameter\n- Change of the URI of the API, such as host name, port or path\n- Change of request or response property name\n- Change of property data type\n- Change of the structure in request or response\n- Change of request validation logic, making it more restrictive\n- Change of error code in the response (e.g. IncorrectParameter -> InvalidParameter)\n- Change of already supported enumerated values or meaning of those values\n- Change of default behaviour when calling without newly added query parameters\n- Making of a previously optional properties in request mandatory\n- Making of headers in request mandatory\n    \n\n### Non-breaking changes\n\n- Removal or loosening of constraint for input property validated via server-side business logic\n- Addition of new functionality or new API\n- Addition of new optional request property or nested property to existing API methods\n- Addition of new properties to existing API responses\n- Addition of new optional header parameters\n- Addition of new optional query parameters\n- Addition of new event types\n- Addition of new error messages and error details while keeping old error code\n- Change of error response message and details while keeping old error code\n- Change of the order of properties in existing API responses\n- Change of mandatory fields to optional fields in an existing API\n- Reducing or extending of enumeration range (when parameters for range control are not used)\n- Change of rate limiting rules\n    \n\n## Deprecation Policy\n\nDeprecated features will be announced via:\n\n- API change log\n    \n\nDeprecated endpoints will remain functional for a minimum of **3 months** before removal.\n\n## **Change Notification**\n\nAll changes must be documented in the API change log.\n\n- For breaking changes, consumers must be notified **3 months** in advance.\n- For breaking changes, that are related to regulator **1 months** in advance.\n    \n\nCommunication channels may include:\n\n- Email notifications\n    \n\n# Enum Values\n\n## General\n\n### Parameter requirement\n\n| Value | Description |\n| --- | --- |\n| Y | Mandatory |\n| N | Optional |\n| C | Conditional |\n\n## Profile\n\n### Company legal form type\n\n| Value | Description |\n| --- | --- |\n| sole_individual | Sole individual |\n| partnership | Partnership |\n| holding_company | Holding company |\n| non_profit | Non-profit organization |\n| limited_liability | Limited liability company |\n| other | Other |\n\n### Company relation type\n\n| Value | Description |\n| --- | --- |\n| owner | Owner |\n| representative | Representative |\n| director | Director |\n| shareholder | Shareholder |\n| ubo | Ultimate beneficial owner |\n\n### Company document type\n\n| Value | Description |\n| --- | --- |\n| registration_document | Registration document |\n| incorporation_document | Incorporation document |\n| articles_of_association_document | Articles of association / Memorandum of association / Company bylaws |\n| proof_of_address_document | Proof of address (if not already mentioned in above documents) |\n| company_register_extract_document | Dated company register extract issued within the last 3 months |\n| company_structure_document | Register of members/shareholders or other documents showing the ownership structure of the company |\n| power_of_attorney_document | Power of attorney for the user if not an authorized director |\n\n### Person document type\n\n| Value | Description |\n| --- | --- |\n| proof_of_residence_document | Proof of residence address |\n\n### Profile address type\n\n| Value | Type | Description |\n| --- | --- | --- |\n| residence | Person | Residence |\n| registration | Company | Registration |\n| correspondence | Person/Company | Correspondence |\n\n### Profile document type\n\n| Value | Description |\n| --- | --- |\n| passport | Passport |\n| identity_card | National government ID card |\n| el_signature | Electronic signature |\n| lite_kyc | Show that profile is under Lite Kyc |\n\n### Profile verification type\n\n| Value | Description |\n| --- | --- |\n| unverified | Unverified |\n| pending | Pending |\n| rejected | Rejected |\n| closed | Closed |\n| verified | Verified |\n\n### Person gender type\n\n| Value | Description |\n| --- | --- |\n| male | Male |\n| female | Female |\n| undefined | Undefined |\n\n### Profile occupation type\n\n| Value | Description |\n| --- | --- |\n| employee | Employee |\n| self_employed | Self employed |\n| student | Student |\n| civil_servant | Civil servant |\n| unemployed | Unemployed |\n| retired | Retired |\n| other | Other |\n\n### Company position type\n\n| Value | Description |\n| --- | --- |\n| manager_of_company | Manager of company |\n| financial_officer | Financial officer |\n| business_development_officer | Business development officer |\n| head_of_sales | Head of sales |\n| head_of_marketing | Head of marketing |\n| head_of_legal | Head of legal |\n| head_of_accounting | Head of accounting |\n| non_managerial_duties | Non-managerial duties |\n| other | Other |\n\n### Company activity type\n\n| Value | Description |\n| --- | --- |\n| retail | Retail |\n| constructions | Constructions |\n| auto_repair | Auto repair |\n| advertising | Advertising |\n| consulting | Consulting |\n| forex_trading | Forex trading |\n| education | Education |\n| insurance | Insurance |\n| legal | Legal |\n| sports | Sports |\n| real_estate | Real estate |\n| logistics | Logistics |\n| crypto_trading | Crypto trading |\n| investment | Investment |\n| information_technologies | Information technologies |\n| financial_institution | Financial institution |\n| tourism | Tourism |\n| gambling | Gambling |\n| state_agency | State Agency |\n| arms_and_other_military_equipment | Arms and other military equipment |\n| trade_in_tobacco_alcohol_drugs | Trade in tobacco products, alcohol, prescription drugs |\n| other | Other |\n\n### Profile purpose for opening type\n\n| Value | Description |\n| --- | --- |\n| daily_banking | Daily banking |\n| saving | Saving |\n| receive_salary | Receive salary |\n| receive_scholarship | Receive scholarship |\n| receive_social_benefits | Receive social benefits |\n| receive_pensions | Receive pensions |\n| receive_from_business_activities | Receive from business activities |\n| send_receive_from_cryptocurrency | Send, receive from_cryptocurrency |\n| send_receive_from_forex_trading | Send, receive from forex trading |\n| send_receive_from_gambling | Send, receive from gambling |\n| investment | Investment |\n| other | Other |\n\n### Profile source of income type\n\n| Value | Description |\n| --- | --- |\n| salary | Salary |\n| pension_allowance_stipend | Pension, allowance, stipend |\n| securities | Securities |\n| individual_activity_or_business | Individual activity or business |\n| rent | Income from rent |\n| inheritance | Inheritance |\n| savings | Savings |\n| other | Other |\n\n### Profile service to use type\n\n| Value | Description |\n| --- | --- |\n| sepa | SEPA payments |\n| swift | SWIFT payments |\n| virtual_debit_card | Virtual debit card |\n| physical_debit_card | Physical debit card |\n\n### Person political exposure type\n\n| Value | Description |\n| --- | --- |\n| none | None |\n| exposed | Exposed |\n| family_member | Family member |\n| associate | Associate |\n\n### Company business activity type\n\n| Value | Description |\n| --- | --- |\n| legal_services | Legal services |\n| audit | Audit |\n| information_technologies | Information technologies |\n| telecommunications | Telecommunications |\n| charity | Charity |\n| financial_services | Financial services |\n| real_estate_construction | Real estate construction |\n| logistics | Logistics |\n| farming_agricultural_activity | Farming agricultural activity |\n| travel_agencies_activities | Travel agencies activities |\n| trading_of_petroleum_products | Trading of petroleum products |\n| virtual_currencies_related_activities | Virtual currencies related activities |\n| health_care | Health care |\n| pharmaceutical_business | Pharmaceutical business |\n| payment_operations | Payment services |\n| organizing_arrangement_auctions | Organizing arrangement auctions |\n| gambling_activities | Gambling activities |\n| electronic_money_institution | Regulated financial institutions |\n| trade_in_means_of_transport | Trade in means of transport |\n| trade_in_arms_ammunition | Trade in arms ammunition |\n| trade_by_internet | Trade by internet |\n| currency_exchange | Currency exchange |\n| metals_stones_activities | Metals stones activities |\n| fx_dealer | Foreign exchange dealer |\n| online_merchant | Online merchant |\n| e_gaming | Internet gaming |\n| advertising | Advertising |\n| affiliate | Affiliate |\n| trade_in_other_goods | Trade in other goods |\n| other_financial_services | Other financial services |\n| other | Other |\n\n### Company source of funds type\n\n| Value | Description |\n| --- | --- |\n| owner_capital | Direct clients funds |\n| operating_income | Acquiring bank |\n| investment_income | Payment service provider |\n| loans | Loans |\n| virtual_currencies_activities | Business settlements |\n| other | Other |\n\n### Company use of account type\n\n| Value | Description |\n| --- | --- |\n| business_operation | Business operations |\n| segregated_client_funds | Segregated client funds (B2C) Account for licensed businesses for holding third-party funds and executing payments on behalf of customers |\n| introducing_agent | Introducing agent |\n| initial_capital | Initial capital |\n| correspondent_payments | Correspondent payments |\n| settlement_payments | Settlement payments |\n| other | Other |\n\n### Company scope of services type\n\n| Value | Description |\n| --- | --- |\n| eur_in_eea | SEPA EUR |\n| swift_multi_currency | SWIFT multi-currency global |\n| swift_dedicated_account | Dedicated SWIFT account |\n| virtual_debit_card | Virtual debit card |\n| physical_debit_card | Physical debit card |\n\n### Profile additional document type\n\n| Value | Description |\n| --- | --- |\n| registration_document | Registration document |\n| incorporation_document | Incorporation document |\n| incumbency_certificate | Certificate of Incumbency |\n| association_memorandum_bylaws_articles | Articles of association/memorandum/bylaws |\n| company_structure | Company structure |\n| attorney_power | Power of Attorney |\n| address_proof | Proof of address |\n| residence_proof | Proof of Residence |\n| domain_ownership_proof | Proof of domain ownership |\n| provided_services_proof | Proof of provided services |\n| financial_statement | Financial Statement |\n| ownership_scheme | Ownership scheme |\n| license | License |\n| aml_policy | AML Policy |\n| wolfsburg_questionnaire | Wolfsburg Questionnaire |\n| partner_agreement | Partner Agreement |\n| other | Other |\n\n## Customer Agreement\n\n### Customer agreement type\n\n| Value | Description |\n| --- | --- |\n| privacy_policy | Privacy policy |\n| service_agreement | Service agreement |\n\n## Third Party\n\n### Third party type\n\n| Value | Description |\n| --- | --- |\n| egov | EGov |\n\n## Wallet\n\n### Wallet status\n\n| Value | Description |\n| --- | --- |\n| active | Active |\n| suspended | Suspended |\n| frozen | Frozen |\n| disabled | Disabled |\n\n## Transaction\n\n### Transaction direction\n\n| Value | Description |\n| --- | --- |\n| incoming | Incoming |\n| outgoing | Outgoing |\n\n### Transaction status\n\n| Value | Description |\n| --- | --- |\n| created | Created |\n| pending | Pending |\n| system_approved | Approved by system |\n| manual_approval | Approved by admin |\n| processed | Processed |\n| failed | Failed |\n| completed | Completed |\n| rejected | Rejected |\n| refund | Refund |\n\n### Transaction service\n\n| Value | Description |\n| --- | --- |\n| nano_transfer | Sepa |\n| nano_inner_transfer | Between own accounts |\n| nano_inside_transfer | Between customers |\n| nano_swift_transfer | Swift transfer |\n| nano_instant_transfer | Sepa instant trasnfer |\n| nano_plais_transfer | Plais |\n| nano_system_trasnfer | Between accounts |\n| nano_manual_transfer | Manual transfer from admin |\n| nano_cc_transfer | Internal transfer |\n| nano_card_transfer | Card transfer |\n| nano_refund | Refund |\n| fee | Fee |\n| fee_transfer | Fee |\n| fee_maintenance | Fee maintenance |\n| fee_conversion | Conversion fee |\n| fee_swift_account_open | Swift account open fee |\n| fee_sepa_account_open | Sepa account open fee |\n| fee_card_issue_virtual | Fee for issue card |\n| fee_card_issue_plastic | Fee for issue card |\n| fee_card_maintenance_plastic | Fee maintenance |\n| fee_card_maintenance_virtual | Fee maintenance |\n| fee_large_balance | Fee large balance |\n| fee_negative_interest | Fee negative interest |\n| fee_manual | Fee manual |\n| fee_refund | Fee refund |\n| fee_commitment | Fee commitment |\n| cc_swift_sha | Currency cloud swift transfer |\n| cc_local | Currency cloud internal transfer |\n| co_swift_transfer | Swift transfer |\n| bank_transfer | Bank trasnfer |\n| bank_inner_transfer | Bank transfer between own accounts |\n| bank_inside_transfer | Bank transfer between customers |\n\n## Two factor authentication\n\n### Two factor authentication type\n\n| Value | Description |\n| --- | --- |\n| transfer | Transfer |\n\n### Two factor authentication provider\n\n| Value | Description |\n| --- | --- |\n| sms | SMS |\n| whats_app | WhatsApp |\n\n## Card order\n\n### Card order status\n\n| Value | Description |\n| --- | --- |\n| created | Created |\n| system_approved | System approved |\n| system_rejected | System rejected |\n| manual_approved | Manual approved |\n| manual_rejected | Manual rejected |\n| failed | Failed |\n| completed | Completed |\n\n### Card order delivery method\n\n| Value | Description |\n| --- | --- |\n| post | Post |\n\n## Card\n\n### Card status\n\n| Value | Description | Type |\n| --- | --- | --- |\n| created | Created | Virtual / Plastic |\n| waiting_pin | Waiting PIN set | Plastic |\n| waiting_cvv | Waiting CVV set | Plastic |\n| sent | Sent | Plastic |\n| active | Active | Virtual / Plastic |\n| suspended | Suspended | Virtual / Plastic |\n| closed | Closed | Virtual / Plastic |\n\n### Card stop cause\n\n| Value | Description |\n| --- | --- |\n| stolen | Stolen |\n| lost | Lost |\n| stopped | Stopped |\n| closed | Closed |\n| pin_not_set | Pin not set |\n\n## Rule\n\n### Rule status\n\n| Value | Description |\n| --- | --- |\n| system_approved | System appoved |\n| system_stopped | System stopped |\n| system_triggered | System triggered (transaction is processed) |\n\n### Rule type\n\n| Value | Description |\n| --- | --- |\n| transaction_sum_in_period | Rule type |\n| transaction_counterparty | Rule type |\n\n## Risk\n\n### Risk status\n\n| Value | Description |\n| --- | --- |\n| none | None |\n| pending | Pending |\n| rejected | Rejected |\n| verified | Verified |\n\n## Webhook\n\n### Webhook type\n\n| Value | Description |\n| --- | --- |\n| balance_update | Balance update |\n| wallet_create | After wallet is created |\n| profile_verification_change | After profile verification is changed |\n| rule_triggered | After rule processed |\n| risk_status_change | Risk status is changed |\n\n# Scenarios\n\n## Profile\n\n### Personal profile creation\n\n1. Create person profile using endpoint [Create profile (Person)](#55f985d4-8bbb-479e-a980-ce11ae35b14f). **remoteId** can be used to prevent duplicates from client.\n2. Add **residence** and **correspondence** addresses using [Add address](#4fbdcf22-9464-4892-97fe-919059c02948) endpoint.\n3. Fill questionnaires if required [Questionnaire (Person)](#72f4e0d3-c98b-4f26-a0c4-5c701cc2cd5a)\n4. Create user identification.  \n    4.1 [Get identity URL](#d6b00803-547c-445d-b1da-22b8e15cc98c). In this endpoint will be provided url for our identification provider. All data will be filled automatically.  \n    4.2 [Add identity (Person)](#52c52102-73a7-4dd8-ba97-a211bb5381d9). Data will be filled by client. Client must have identification provider. Client must provide access to his provider administration panel. Identification provider has to be approved by Bank of Lithuania.\n5. Add proof of addresses using [Add/Update proof of address (Person)](#260410da-9cec-41b0-be0f-5485b432f5fe)\n6. Verify profile after all data is collected.  \n    6.1 Verify profile using administration panel.  \n    6.2 Verify profile using endpoint. [Create verification](#20cd83dd-0f87-4183-a464-269f6ab15b9e). Verify profile using endpoint requires having appropriate agreement or license.\n7. Accept customer agreement [Accept customer agreement](#4e36d0e0-8b52-432c-b95c-755e8f088035).\n    \n\n### Business profile creation\n\n1. Create company profile using endpoint [Create profile (Company)](#3e4bdf37-7281-42cd-9aae-c1953935ae3e). **remoteId** can be used to prevent duplicates from client.\n2. Add **registration** and **correspondence** addresses using [Add address](#4fbdcf22-9464-4892-97fe-919059c02948) endpoint.\n3. Fill questionnaires if required [Questionnaire (Company)](#4dbd1f56-f440-4a76-bfa2-cac207b3b66a)\n4. Add person profiles with appropriate type to the company [Add company relation](#5589c60b-e81d-41d0-81f6-0ccb6a49de62). Person profile creation flow is written above.\n5. Add company documents using [Add/Update documents (Company)](#136778e1-891a-4420-a8ee-058f7f231d84)\n6. Verify profile after all data is collected.  \n    6.1 Verify profile using administration panel.  \n    6.2 Verify profile using endpoint. [Create verification](#20cd83dd-0f87-4183-a464-269f6ab15b9e). Verify profile using endpoint requires having appropriate agreement or license.\n7. Accept customer agreement [Accept customer agreement](#4e36d0e0-8b52-432c-b95c-755e8f088035).\n    \n\n### Personal profile creation (Lite KYC)\n\n1. Create person profile using endpoint. [Create profile (Person)](#55f985d4-8bbb-479e-a980-ce11ae35b14f). **remoteId** can be used to prevent duplicates from client.\n2. Add **residence** and **correspondence** addresses using [Add address](#4fbdcf22-9464-4892-97fe-919059c02948) endpoint.\n3. Verify profile after all data is collected. Verify profile using endpoint (**isLiteKyc** property has to be true). [Create verification](#20cd83dd-0f87-4183-a464-269f6ab15b9e). Verify profile using endpoint requires having appropriate agreement or license.\n    \n\n### Profile data update (Person)\n\n1. Update profile data could be done using administration panel.\n2. Update person profile using endpoint [Update profile (Person)](#e2877392-5693-4947-a067-9e6aee395253). Update profile using endpoint requires having appropriate agreement or license.\n3. Update **residence** and **correspondence** addresses using [Update address](#a3f47a07-124d-4483-b464-c0f94f0edf1c) endpoint.\n4. Update questionnaires. [Update questionnaire (Person)](#127cc3b1-540d-4baf-91fb-5e90b9da2aca)\n5. Update user identification.  \n    5.1 [Update identity (Person)](#aa12dd71-5754-492b-a6ec-2319125ddd69). Data will be filled by client. Client must have identification provider. Client must provide access to his provider administration panel. Identification provider has to be approved by Bank of Lithuania.\n6. Update proof of addresses using [Add/Update proof of address (Person)](#260410da-9cec-41b0-be0f-5485b432f5fe)\n7. Add extra document using endpoint [Add/Update document (Person, Company)](#39ab5224-8904-4d70-93d2-e28e8f9b714e).\n    \n\n### Profile data update (Business)\n\n1. Update company profile using endpoint [Update profile (Company)](#8db7e31e-1e36-4ee4-b3ed-2517ddd80667). Update profile using endpoint requires having appropriate agreement or license.\n2. Update **registration** and **correspondence** addresses using [Update address](#a3f47a07-124d-4483-b464-c0f94f0edf1c) endpoint.\n3. Update questionnaires [Update questionnaire (Company)](#f75d4594-f1d0-425e-a715-a83b458af953)\n4. Update person profiles with appropriate type to the company [Add company relation](#5589c60b-e81d-41d0-81f6-0ccb6a49de62)/[Delete company relation](#b3a30dee-1d21-45d7-a064-34212f8396b8). Person profile creation flow is written above.\n5. Update company documents using [Add/Update documents (Company)](#136778e1-891a-4420-a8ee-058f7f231d84)\n6. Add extra document using endpoint [Add/Update document (Person, Company)](#39ab5224-8904-4d70-93d2-e28e8f9b714e).\n    \n\n### Close profile\n\n1. Close profile could be done using administration panel.\n    \n\n## Account\n\n### Open account for private or company profile\n\n1. Account count be opened for **verified** profiles. How to verified profile look at profile scenarios.  \n    1.1 Open account using administration panel.  \n    1.2 Open account using endpoint. [Create account](#51320f71-19c3-42a5-ad76-5f32cc6afa01). Open account using endpoint requires having appropriate agreement or license. **remoteId** can be used to prevent duplicates from client. After account opened will be provided account id. IBAN will be issued in few seconds. After IBAN will be issued webhook [Account create event](#7e6e3976-c4be-44ee-b34e-bfe8ae87c51d) will be sent to provided url.\n    \n\n### Close account\n\n1. Account can be closed using administration panel.\n    \n\n### Change account status\n\n1. Account status can be changed using administration panel.\n    \n\n## Card\n\nCard creation is available for The European Economic Area (EEA) countries. If card delivery address or profile address is not in EEA countries card creation will fail.\n\n### Virtual card creation\n\n1. Create card order using endpoint. [Create card order](#28b2f236-4bc5-4973-9392-bfa13784e862). Parameter **isVirtual** should be **true**.\n2. Card order approval or rejection could be done using API or administration panel.  \n    2.1 Approve card order on Admin panel  \n    2.2 Approve card order using endpoint [Approve card order](#ed792ec4-2290-45ee-8878-69a2341b9349)\n    \n\n### Plastic card creation\n\n1. Create card order using endpoint. [Create card order](#28b2f236-4bc5-4973-9392-bfa13784e862). Parameter **isVirtual** should be **false**. For plastic card order is mandatory **useProfileAddress** or **deliveryAddress**. Card will be sent to selected address.\n2. Card order approval or rejection could be done using API or administration panel.2.1 Approve card order on Admin panel2.2 Approve card order using endpoint [Approve card order](#ed792ec4-2290-45ee-8878-69a2341b9349)\n3. Pin set up. After pin set up card is sent to processor to make plastic card and will send it to client. If pin is not set up in 48 hours these card is closed automatically. Pin set up can be done using:3.1 Iframe [Card pin set (iframe)](#d988ec72-3941-464a-a033-ba4318fd4278)3.2 Encrypted [Card pin set (encypted)](#6677f9c9-9a03-4482-8545-fc455fd965ec)\n4. Card activation. When card is reached their customer card need to be activated using CVV code on the card. Card can be activated using:  \n    4.1 Iframe [Card activate (iframe)](#a2f1c267-823a-4006-9d6e-0de4d1d4c85f)  \n    4.2 Encrypted [Card active (encypted)](#42d57646-1496-4b69-b4b0-3f095d292559)\n    \n\n### Card e-commerce enable\n\n1. To enable e-commerce for card need to set up 3DS password.  \n    1.1 Iframe [Card 3d password set (iframe)<br>](#f97dc395-fd7f-4745-a111-a222a6e90aa3)1.2 Encrypted [Card 3d password set (encypted)](#fb178c35-c562-401c-b6ae-993cb1159b0e)\n2. Enable/disable e-commerce settings using [Card security parameters set](#f095f4ff-b236-4674-a387-c5db9725a659)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12483031","team":1232237,"collectionId":"07de3b33-dfc0-49cf-8c7d-7e0e9b7a80a5","publishedId":"TVCZYW7A","public":true,"publicUrl":"https://documenter-api.postman.tech/view/12483031/TVCZYW7A","privateUrl":"https://go.postman.co/documentation/12483031-07de3b33-dfc0-49cf-8c7d-7e0e9b7a80a5","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-09-28T08:24:04.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"production - v2.0","id":"de305d90-985c-47a5-a0a0-85f30b515e26","owner":"12483031","values":[{"key":"host","value":"https://api.verifo.com","enabled":true},{"key":"version","value":"v2.0","enabled":true},{"key":"apiKey","value":"apiKey","enabled":true},{"key":"apiSecret","value":"apiSecret","enabled":true},{"key":"hmacAuthHeader","value":"V2.0-HMAC-SHA512 Key=apiKey,Signature=1580a3ab8871482426fb80ef14423925a1140e89aacbaa91c02933629b9dfc7195ed3ff0f92680b0c22c80fc002cae99e0a246b02dcf4b558ce8fe5f2ab62ba1","enabled":true},{"key":"timestamp","value":"1598415974","enabled":true},{"key":"nonce","value":"159841596895764","enabled":true},{"key":"bodyParams","value":"","enabled":true},{"key":"queryParams","value":"","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/33021a61858c2f0536e8ff67a24f12ad28995e6008254913c80ed9df0f55e3a2","favicon":"https://res.cloudinary.com/postman/image/upload/v1598346860/team/xyjj8m8llcb4eoy2fy6h.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"production - v2.0","value":"12483031-de305d90-985c-47a5-a0a0-85f30b515e26"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TVCZYW7A"}