Appearance
CRM Profile Updates from Verification Provider
When changes are made to the client's profile in the Verification Provider, that information is used to update information on the Client's CRM profile.
TLDR;
The current syncronization mechanism is based on specific mapping from information provided by the Verification Provider to fields within the CRM.
The information is mapped as follows:
| Verification Provider Information Field | CRM Profile Field | Comments |
|---|---|---|
firstName, firstNameEn | firstname | The firstname field is taken from firstNameEn if available; otherwise, it uses firstName. |
lastName, lastNameEn | lastname | The lastname field is taken from lastNameEn if available; otherwise, it uses lastName. |
dob | birthday | The dob field is converted to ISO format (YYYY-MM-DD). |
lang | reflang | The lang field is converted from ISO2/ISO3 code or English name to the corresponding language name. |
occupation | occupation | Directly mapped from the occupation field in Verification Provider. |
citizenship, nationality, country | citizenships | Converted from the ISO3 code from the verification provider to the corresponding CRM citizenship ID. |
placeOfBirth, stateOfBirth, countryOfBirth | birth_place | The birth_place field is constructed by concatenating placeOfBirth, stateOfBirth, and countryOfBirth. |
nationalIdNumber | rc_id_no | Directly mapped from nationalIdNumber if available. |
gender | gender | Converted from Male, Female, M, or F to either M or F for CRM. |
age | age_group | Age is calculated from dob and mapped to the corresponding age_group in CRM. |
income | income | NOT CURRENTLY IMPLEMENTED DUE COMPATIBILITY ISSUES |
tin | tin | Directly mapped from tin field in Verification Provider if available. |
nationalIdNumber | national_id | Extracted and converted to a numeric value, removing any non-numeric characters. |
compliance_statuses | compliance_statuses | Automatically set to rejected if the age is below 18, otherwise updated by various processes. |
accountstatus | accountstatus | Automatically set to Under age if the age is below 18. |
Note
When multiple fields exist in the verification provider's profile, the first choice in the list that has a value is chosen. For example, for citizenships 3 fields in the verification provider are reviewed: citizenship, nationality, country. If citizenship is empty but nationality and country have values, the value of nationality is used.
Known Available CRM Fields
| Block | Label | Field | Field Type | Visible | Read Only |
|---|---|---|---|---|---|
Client Information (client-information) | CRM Id | account_no | string | Read Only | |
Client Information (client-information) | First Name | firstname | string | ||
Client Information (client-information) | Department | department | picklist | Read Only | |
Client Information (client-information) | RSA ID No | tin | string | ||
Client Information (client-information) | Last Name | lastname | string | ||
Client Information (client-information) | email1 | email | Read Only | ||
Client Information (client-information) | Phone | phone | phone | ||
Client Information (client-information) | Questionnaire Completed | questionnaire_completed | checkbox | Read Only | |
Client Information (client-information) | Mobile | mobile | phone | ||
Client Information (client-information) | Date Of Birth | birthday | date | ||
Client Information (client-information) | Other Email | email2 | email | ||
Client Information (client-information) | Assigned To | assigned_user_id | user | ||
Client Information (client-information) | Support Status | support_status | picklist | Read Only | |
Client Information (client-information) | FTD | funded | checkbox | Read Only | |
Client Information (client-information) | Created Time | createdtime | date | Read Only | |
Client Information (client-information) | Modified Time | modifiedtime | date | Read Only | |
Client Information (client-information) | Balance | balance | number | Read Only | |
Client Information (client-information) | FTD owner | ftd_owner | user | Read Only | |
Client Information (client-information) | Citizenship | citizenships | picklist | ||
Client Information (client-information) | Gender | gender | picklist | ||
Client Information (client-information) | UI Language | languages | picklist | ||
Client Information (client-information) | Customer Language | reflang | string | ||
Client Information (client-information) | Client Status | accountstatus | picklist | ||
Client Information (client-information) | Registration IP | insert_ip | string | Read Only | |
Client Information (client-information) | Retention Status | retention_status | picklist | ||
Client Information (client-information) | Compliance Status | compliance_statuses | picklist | ||
Client Information (client-information) | Last Trade Date | last_trade_date | date | Read Only | |
Client Information (client-information) | Last Interaction Date | last_interaction_date | date | Read Only | |
Client Information (client-information) | Base Currency | currencies | picklist | ||
Client Information (client-information) | Last Comment | last_comment | string | Read Only | |
Client Information (client-information) | Phone verified | phone_verified | phone | Read Only | |
Client Information (client-information) | Registration State | registration_states | picklist | Read Only | |
Client Information (client-information) | Compliance Agent | compliance_agent | user | ||
Client Information (client-information) | Compliance Notes | compliance_note | string | ||
Client Information (client-information) | Terms and Conditions | terms | checkbox | ||
Client Information (client-information) | Compliance Modified Date | compliance_status_modification | string | Read Only | |
Client Information (client-information) | Client Disable | live_accounts_disabled | checkbox | Read Only | |
Client Information (client-information) | Valid Phone | phone_is_valid | checkbox | ||
Client Information (client-information) | Validation Required | validation_required | string | Read Only | |
Client Information (client-information) | Place of Birth | birth_place | string | ||
Client Information (client-information) | Interest rate | t_quality | picklist | ||
Client Information (client-information) | Phone Duplicate of | phone_duplicate_of | link | Read Only | |
Client Information (client-information) | Original Retention Owner | original_retention_owner | user | ||
Client Information (client-information) | Service Transfer | service_transfer | checkbox | ||
Client Information (client-information) | Weekend Registration | weekend_registration | checkbox | Read Only | |
Client Information (client-information) | Linked Partner | linked_partner | number | Read Only | |
Client Information (client-information) | Age group | age_group | picklist | ||
Client Information (client-information) | Income | income | number | ||
Client Information (client-information) | Occupation | occupation | string | ||
Client Information (client-information) | Active Cooma leaders | leaders_count | number | Read Only | |
Client Information (client-information) | Call recordings count | call_recording_counts | number | Read Only | |
Client Information (client-information) | Required Documents | required_documents | number | Read Only | |
Client Information (client-information) | Uploaded Documents | uploaded_documents | number | Read Only | |
Client Information (client-information) | Last User Agent | user_agent | string | Read Only | |
Client Information (client-information) | Comments Count | comments_count | number | Read Only | |
Address Information (address-information) | Country | countries | picklist | ||
Address Information (address-information) | Address | address | textarea | ||
Address Information (address-information) | City | city | string | ||
Address Information (address-information) | Code | post_code | string | ||
Address Information (address-information) | State | country_states | picklist | Read Only | |
Address Information (address-information) | Building | building | string | ||
Marketing Information (marketing-information) | Lead Exist | leadsource | link | Read Only | |
Marketing Information (marketing-information) | Client Source | client_source | string | ||
Marketing Information (marketing-information) | Referral | referral | string | ||
Marketing Information (marketing-information) | Platform | platforms | picklist | Read Only | |
Marketing Information (marketing-information) | PandaPartnerId | partner_id | number | Read Only | |
Marketing Information (marketing-information) | Campaign | Campaign | string | ||
Marketing Information (marketing-information) | Promocode | promocode | string | Read Only | |
Marketing Information (marketing-information) | Accept Promotions | EmailAds | checkbox | ||
Marketing Information (marketing-information) | SMS Verification | sms_verified | checkbox | Read Only | |
Marketing Information (marketing-information) | Professional Classification | professional_classification | picklist | Read Only | |
Marketing Information (marketing-information) | Invited by | invited_by_crmid | link | Read Only | |
Marketing Information (marketing-information) | Marketing Name | marketing_name | string | ||
Marketing Information (marketing-information) | Affiliate Source | affiliate_source | string | ||
Marketing Information (marketing-information) | Marketing Plan | aff_plan | picklist | Read Only | |
Marketing Information (marketing-information) | Renewal Partner ID | renewal_partner_id | number | ||
Marketing Information (marketing-information) | Renewal Date | renewal_date | date | ||
Marketing Information (marketing-information) | Client Level | client_level | picklist | Read Only | |
Custom Information (custom-information) | Last Login Date | login_date | date | Read Only | |
Custom Information (custom-information) | First Trade Date | first_trade_date | date | Read Only | |
Custom Information (custom-information) | Last Deposit Date | last_deposit_date | string | Read Only | |
Custom Information (custom-information) | First Deposit Date | first_deposit_date | string | Read Only | |
Custom Information (custom-information) | FTD Amount | ftd_amount | number | Read Only | |
Custom Information (custom-information) | Net Deposit | net_deposit | number | Read Only | |
Custom Information (custom-information) | Deposit Counts | countdeposits | number | Read Only | |
Custom Information (custom-information) | Withdrawals Count | countwithdrawals | number | Read Only | |
Custom Information (custom-information) | Amount of trades | num_trades | number | Read Only | |
Custom Information (custom-information) | Fees Count | countfees | number | Read Only | |
Custom Information (custom-information) | Assign date | assign_date | string | Read Only | |
Custom Information (custom-information) | Last assigned to | last_assigned_to | user | Read Only | |
Custom Information (custom-information) | Client Score | ftd_score | string | Read Only | |
Custom Information (custom-information) | Customer Id | customer_id | number | Read Only | |
Custom Information (custom-information) | Last assigned by | last_assigned_by | user | Read Only | |
Custom Information (custom-information) | Fixed Notes | fixed_notes | textarea | ||
Custom Information (custom-information) | Device Platform | device_platform | string | Read Only | |
Custom Information (custom-information) | Device Model | device_model | string | Read Only | |
Custom Information (custom-information) | Device Manufacturer | device_manufacturer | string | Read Only | |
Custom Information (custom-information) | Device Version | device_version | string | Read Only | |
Custom Information (custom-information) | Email Verification Required | email_verification_required | checkbox | Read Only | |
Custom Information (custom-information) | Social Following | is_social_following | checkbox | Read Only | |
Custom Information (custom-information) | Custom_1 | custom_1 | string | ||
Custom Information (custom-information) | Custom_2 | custom_2 | string | ||
Custom Information (custom-information) | Custom_3 | custom_3 | string | ||
Custom Information (custom-information) | Last User-agent Manufacturer | last_user_agent_manufacturer | string | Read Only | |
Custom Information (custom-information) | Last User-agent Platform | last_user_agent_platform | string | Read Only | |
Custom Information (custom-information) | Last User-agent Model | last_user_agent_model | string | Read Only | |
Custom Information (custom-information) | Last User-agent Browser | last_user_agent_browser | string | Read Only | |
Custom Information (custom-information) | Regulation Note | regulation_note | string | ||
Custom Information (custom-information) | Do Not EMail | do_not_email | checkbox | ||
Custom Information (custom-information) | Close Only Mode | close_only_mode | checkbox | Read Only | |
Questionnaire Summary (questionnaire-summary) | Customer Classification | customer_classifications | picklist | ||
Questionnaire Summary (questionnaire-summary) | Total Scoring | score | string | ||
Questionnaire Summary (questionnaire-summary) | National ID | national_id | string | ||
Questionnaire Summary (questionnaire-summary) | Company Name | company_name | string | ||
Questionnaire Summary (questionnaire-summary) | AML Risk | aml_risk | picklist | ||
Questionnaire Summary (questionnaire-summary) | Questionnaire reset count | questionnaire_reset_count | number | Read Only |
Known Available Verification Provider Profile Fields
| Property | Description | Property Type |
|---|---|---|
address.country | Alpha-3 country code of the address. | String |
address.postCode | Address postal code. | String |
address.state | State, region, district, county or another territorial entity inside a country. | String |
address.street | Street name. | String |
address.subStreet | Additional information related to the street, such as house number or other details. | String |
address.town | City, town, or another settlement. | String |
agreement.createdAt | Date and time (GMT) when the applicant confirmed his/her consent to the submitting and processing of personal data. | Date |
agreement.source | Specifies the source from which the applicant confirmed the agreement (WebSDK, MSDK). | String |
agreement | Contains information about the applicant consent to submitting and processing the personal data. | Object |
applicantPlatform | The platform from which the applicant registered in the system and/or provided profile data (API, Web, Android, iOS). | String |
authCode | JWT token to sign in a user. | String |
beneficiaries.applicant | Applicant profile data. | Object |
beneficiaries.applicantId | Applicant identifier of the beneficiary. | String |
beneficiaries.beneficiaryInfo | Structure that contains the beneficiary contact data. | Object |
beneficiaries.id | Autogenerated key for all KYB 2.0 beneficiaries. | String |
beneficiaries.imageIds | Image IDs represent a document uploaded. | Array<String> |
beneficiaries.inRegistry | Matching to a Corporate registry (true, false, or null). | Boolean |
beneficiaries.positions | Positions in the company that the beneficiary is holding. | Array<String> |
beneficiaries.shareSize | Percentage of ownership if the beneficiary is a shareholder of the company. | Double |
beneficiaries.type | Beneficiary single role in the company control and ownership structure. | String |
beneficiaries.types | Beneficiary roles for the new data structure, when one entity may have multiple roles. | Array<String> |
beneficiaryInfo.dob | Beneficiary date of birth. | Date |
beneficiaryInfo.email | Beneficiary email address. | String |
beneficiaryInfo.firstName | First name of the beneficiary. | String |
beneficiaryInfo.lastName | Last name of the beneficiary. | String |
beneficiaryInfo.taxResidenceCountry | Country where the beneficiary pays taxes. Presented as an alpha-3 code. | String |
clientId | Unique identifier of you as our client in the Verification Provider system. | String |
createdAt | Date and time (GMT) when the applicant profile was created in the Verification Provider system. Format: YYYY-MM-DD HH:MI:SS. | Date |
docSets.captureMode | Mode applied in case the docapture method is used (manualAndAuto, manualOnly). | String |
docSets.fields.name | The field name (e.g., firstName, lastName, email). | String |
docSets.fields.required | True if the field is required for verification, false if not. | Boolean |
docSets.fields | Includes objects describing the document data fields that should be filled with personal information. | Array<Object> |
docSets.idDocSetType | Human-readable identifier of the document set type (e.g., IDENTITY, SELFIE, PROOF_OF_RESIDENCE). | String |
docSets.questionnaireDefId | Identifier of the questionnaire that is added to the verification level and is to be or has already been filled by the applicant. | String |
docSets.types | Includes the types of documents that are required for a particular idDocSetType to pass verification. | Array<String> |
docSets.uploaderMode | Mode applied in case the docapture method is used (always, never, fallback). | String |
docSets.videoRequired | Method of passing the document upload step that can be set up when configuring a verification level. | String |
email | Applicant email address. Mandatory if email verification is required. | String |
externalUserId | Unique applicant identifier as registered in Brand CRM. | String |
fixedInfo.addresses | Includes data objects containing the applicant address details provided by the applicant. | Array<Object> |
fixedInfo.country | Applicant country of birth. Presented as an alpha-3 country code. | String |
fixedInfo.countryOfBirth | Applicant country of birth. Presented as an alpha-3 country code. | String |
fixedInfo.dob | Applicant date of birth (format YYYY-mm-dd). | Date |
fixedInfo.firstName | Applicant first name in the original language. | String |
fixedInfo.firstNameEn | Automatic transliteration of the applicant first name into Latin characters. | String |
fixedInfo.gender | Applicant gender that can be male or female (M or F). If the gender is not specified in the applicant profile, this field is absent. | String |
fixedInfo.lastName | Applicant last name in the original language. | String |
fixedInfo.lastNameEn | Automatic transliteration of the applicant last name into Latin characters. | String |
fixedInfo.legalName | Legal name of the company the applicant is related to (UBO or shareholder). | String |
fixedInfo.middleName | Applicant middle name in the original language. | String |
fixedInfo.middleNameEn | Automatic transliteration of the applicant middle name into Latin characters. | String |
fixedInfo.nationality | Applicant country of origin. Presented as an alpha-3 country code. | String |
fixedInfo.placeOfBirth | Applicant place of birth (city, town, or another settlement type). | String |
fixedInfo.stateOfBirth | State, region, district, county or another territorial entity of birth inside a country, if applicable. | String |
fixedInfo.tin | Taxpayer identification number that is unique to each taxpayer. | String |
fixedInfo | General applicant information that is submitted by the applicant via the Web or Mobile SDK or by you via this API method. Verification Provider should not change this information but use it to cross-validate with the data recognized from the applicant documents. | Object |
id | Unique applicant identifier in the Verification Provider system (applicantId). | String |
idDocs.address | Includes the applicant address details. | Object |
idDocs.country | Alpha-3 code of the country where the document was issued. | String |
idDocs.dob | Applicant date of birth as specified in the document. | Date |
idDocs.firstName | Applicant first name in the original language as it is in the document. | String |
idDocs.firstNameEn | Automatic transliteration of the applicant first name into Latin characters. | String |
idDocs.idDocType | Type of document that is specified in the level to be provided for verification. | String |
idDocs.issueAuthorityCode | Code of the issuing Authority that is in charge of issuing the uploaded document. | String |
idDocs.issuedDate | Date when the identity document was issued. | Date |
idDocs.lastName | Applicant last name in the original language as it is in the document. | String |
idDocs.lastNameEn | Automatic transliteration of the applicant last name into Latin characters. | String |
idDocs.middleName | Applicant middle name in the original language as it is in the document. | String |
idDocs.middleNameEn | Automatic transliteration of the applicant middle name into Latin characters. | String |
idDocs.number | Unique registration number of the document. | String |
idDocs.validUntil | Date when the document validity expires. | Date |
idDocs | Includes data objects containing information extracted from the applicant documents. | Array<Object> |
info.addresses | Includes data objects containing the applicant address details extracted from the PoA documents submitted by the applicant. | Array<Object> |
info.companyInfo.address | Represents the company address. | Object |
info.companyInfo.beneficiaries | Contains applicantIds of beneficiaries and additional information such as position and type. | Array<Object> |
info.companyInfo.companyName | The name of the company. | String |
info.companyInfo.controlScheme | Description of the control scheme of the company ownership or group of entities. | String |
info.companyInfo.country | Alpha-3 code of the country where the company is legally registered. | String |
info.companyInfo.email | Company email address. | String |
info.companyInfo.incorporatedOn | Date of company incorporation (format YYYY-mm-dd). | String |
info.companyInfo.legalAddress | Address a legal entity uses to register with a legal authority. | String |
info.companyInfo.noShareholders | When set to true, a company is to be verified with no shareholders specified in the company profile. | Boolean |
info.companyInfo.noUBOs | When set to true, a company is to be verified with no UBOs specified in the company profile. | Boolean |
info.companyInfo.phone | Company phone number. | String |
info.companyInfo.postalAddress | Company postal address. | String |
info.companyInfo.registrationLocation | City, town, or another location where the company was registered. | String |
info.companyInfo.registrationNumber | Unique number assigned to the company when it was registered as a legal entity. | String |
info.companyInfo.taxId | Taxpayer registration number/Code of taxpayer registration. | String |
info.companyInfo.type | Type of legal entity (e.g., private company limited by shares, public limited company, etc.). | String |
info.companyInfo.website | Website URL of the company. | String |
info.companyInfo | Available for company applicants only. Contains general information about the company. | Object |
info.country | Applicant country of birth. Presented as an alpha-3 country code. | String |
info.countryOfBirth | Applicant country of birth. Presented as an alpha-3 country code. | String |
info.dob | Applicant date of birth (format YYYY-mm-dd). | Date |
info.firstName | Applicant first name in the original language. | String |
info.firstNameEn | Automatic transliteration of the applicant first name into Latin characters. | String |
info.gender | Applicant gender (M or F). | String |
info.lastName | Applicant last name in the original language. | String |
info.lastNameEn | Automatic transliteration of the applicant last name into Latin characters. | String |
info.legalName | Legal name of the company the applicant is related to (UBO or shareholder). | String |
info.middleName | Applicant middle name in the original language. | String |
info.middleNameEn | Automatic transliteration of the applicant middle name into Latin characters. | String |
info.nationality | Applicant country of origin. Presented as an alpha-3 country code. | String |
info.placeOfBirth | Applicant place of birth (city, town, or another settlement type). | String |
info.stateOfBirth | State, region, district, county or another territorial entity of birth inside a country, if applicable. | String |
info.tin | Taxpayer identification number that is unique to each taxpayer. | String |
info | General applicant information recognized from the documents that Verification Provider cross-validates with the applicant data provided. | Object |
inspectionId | Unique combination of digits and characters to identify all actions with the applicant’s ID documents. | String |
ipCountry | Alpha-3 country code of the country that owns the IP address from which the applicant got registered and/or submitted the data. | String |
lang | Two-letter code of the language for the SDK and emails sent to the applicant. | String |
memberOf.applicantId | Unique identifier of the company registered as an applicant in the Verification Provider system. | String |
memberOf.fullName | Full name of the company applicant. | String |
memberOf | Includes data objects with the applicant companies' IDs the beneficiary of which the applicant is and which are registered in the Verification Provider system. | Array<Object> |
notes.createdAt | Date and time (GMT) when the note was created. | Date |
notes.moderatorName | Identifier of the one who created the note in the applicant profile. | String |
notes.note | Contains the text of the note added. | String |
notes | Includes objects representing notes added to the applicant profile by you or by Verification Provider operators. | Array<Object> |
phone | Applicant phone number. Mandatory if phone verification is required. | String |
questionnaires.id | Unique identifier of the questionnaire. | String |
questionnaires.sections.items.name | Name representing the question. | String |
questionnaires.sections.items.score | Score assigned to the item. | Integer |
questionnaires.sections.items.value | The applicant's answer to the question. | String |
questionnaires.sections.items | Includes objects, each of which stands for a single question added to the questionnaire. | Object |
questionnaires.sections | Includes objects, each of which is a separate group of questions added to the questionnaire. | Object |
questionnaires | Includes objects describing questionnaires that the applicant is given to complete during (or after) verification. | Array<Object> |
requiredIdDocs.docSets | Includes objects representing specific document sets and their attributes. | Array<Object> |
requiredIdDocs.excludedCountries | Countries that are excluded from the list of supported countries (in alpha-3 country code). | Array<String> |
requiredIdDocs.kybSettings | Includes the thresholds of ownership share that are used to identify the types of company beneficiaries. | Object |
requiredIdDocs.videoIdent | Specifies if the video identification is required (true) or not required (false) to pass verification. | Boolean |
requiredIdDocs | Configuration of steps for the applicant to complete verification, including step types and appropriate documents. | Object |
review.attemptCnt | Counting number of the current verification attempt on the same verification level. | Integer |
review.attemptId | Unique identifier of the current verification attempt. | String |
review.createDate | Date and time (UTC) when the applicant profile was created in the Verification Provider system. | Date |
review.elapsedSincePendingMs | Elapsed time since the applicant verification passed to the pending status. | Integer |
review.levelName | Name of the verification level the applicant has to go through. | String |
review.reviewDate | Date and time (UTC) when the current applicant check was completed. | Date |
review.reviewId | Unique identifier of the applicant profile review in the Verification Provider system. | String |
review.reviewResult | Contains extra details of the applicant verification result. | Object |
review.reviewStatus | Indicates the applicant review status. | String |
review | Explains the details of the current applicant verification status and check result. | Object |
reviewResult.buttonIds | Button identifiers that have been used for applicant rejection. | Array<String> |
reviewResult.clientComment | Human-readable comment that explains the reasons for rejection in detail, and that must not be shown to the applicant. | String |
reviewResult.moderationComment | Human-readable comment that explains the reasons for rejection in detail, and that can be shown to the applicant. | String |
reviewResult.rejectLabels | Includes one or more reasons for rejection. Available if reviewAnswer returns RED. | Array<String> |
reviewResult.reviewAnswer | Explains the review result (GREEN for approved, RED for declined). | String |
reviewResult.reviewRejectType | Indicates the type of rejection (FINAL, RETRY). | String |
riskLabels | Contains information on the applicant risk labels. | Object |
sourceKey | Source key that helps you group clients that send applicants. | String |
tags | Contains tags that you have created and then assigned to the applicant. | Array<String> |
type | Defines the applicant type (individual or company). | Enum |