/plaid-identity-verifications

Foundational GET all handler for: plaid-identity-verifications
A new Identity Verification for the user specified by the client_user_id field. The requirements and behavior of the verification are determined by the template_id provided. If you dont know whether the associated user already has an active Identity Verification, you can specify is_idempotent: true in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated client_user_id and template_id. If an Identity Verification is found, it will be returned unmodified with an 200 OK HTTP status code.

You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow.
ID: NUMBER: This is the Primary key (Numeric) for the Plaid Identity Verification
PLAID_VERIFICATION_ID: VARCHAR2(255): ID of the associated Identity Verification attempt
CLIENT_USER_ID: VARCHAR2(255): A unique ID that identifies the end user in your system This ID can also be used to associate user-specific data from other Plaid products Financial Account Matching requires this field and the linktokencreate clientuserid to be consistent Personally identifiable information such as an email address or phone number should not be used in the clientuserid
PLAID_CREATED_AT: DATE: An ISO8601 formatted timestamp
PLAID_COMPLETED_AT: DATE: An ISO8601 formatted timestamp
PREVIOUS_ATTEMPT_ID: VARCHAR2(255): The ID for the Identity Verification preceding this session This field will only be filled if the current Identity Verification is a retry of a previous attempt
SHAREABLE_URL: VARCHAR2(255): A shareable URL that can be sent directly to the user to complete verification
TEMPLATE_ID: VARCHAR2(255): ID of the associated Identity Verification template
TEMPLATE_VERSION: NUMBER: Version of the associated Identity Verification template
USER_PHONE_NUMBER: NUMBER: A phone number in E164 format
USER_DATE_OF_BIRTH: DATE: The birthdate
IP_ADDRESS: VARCHAR2(45): An IPv4 or IPV6 address
USER_EMAIL_ADDRESS: VARCHAR2(255): A valid email address
USER_GIVEN_NAME: VARCHAR2(255): A string with at least one non-whitespace character with a max length of 100 characters
USER_FAMILY_NAME: VARCHAR2(255): A string with at least one non-whitespace character with a max length of 100 characters
USER_ADDRESS_STREET: VARCHAR2(255): The primary street portion of an address If the user has submitted their address this field will always be filled
USER_ADDRESS_STREET2: VARCHAR2(255): Extra street information like an apartment or suite number
USER_ADDRESS_CITY: VARCHAR2(255): City from the end users address
USER_ADDRESS_REGION: VARCHAR2(255): An ISO 3166-2 subdivision code Related terms would be state province prefecture zone subdivision etc
USER_ADDRESS_POSTAL_CODE: NUMBER: The postal code for the associated address Between 2 and 10 alphanumeric characters For US-based addresses this must be 5 numeric digits
USER_ADDRESS_COUNTRY: VARCHAR2(2): Valid capitalized two-letter ISO code representing the country of this object Must be in ISO 3166-1 alpha-2 form
USER_ID_NUMBER_VALUE: VARCHAR2(255): Value of identity document value typed in by user Alpha-numeric with all formatting characters stripped
USER_ID_NUMBER_TYPE: VARCHAR2(255): A globally unique and human readable ID type specific to the country and document category For more context on this field see Hybrid Input ValidationPossible values: ardni audriverslicense aupassport brcpf casin clrun cnresidentcard conit dkcpr egnationalid esdni esnie hkhkid inpan itcf jocivilid jpmynumber kehudumanamba kwcivilid mxcurp mxrfc mynric ngnin nzdriverslicense omcivilid phpsn plpesel rocnp sanationalid sepin sgnric trtckimlik usssn usssnlast4 zasmartid
USER_STATUS: VARCHAR2(255): The status of this Identity Verification attemptactive - The Identity Verifi

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

{ "items": [ { "cephisso_platform_accounts_id": 0, "client_user_id": "string", "created_by": "string", "created_on": "2019-08-24T14:15:22Z", "data_lineage": null, "documentary_verification_attempt": 0, "documentary_verification_documents_analysis_authenticity": "string", "documentary_verification_documents_analysis_extracted_data_date_of_birth": "2019-08-24T14:15:22Z", "documentary_verification_documents_analysis_extracted_data_expiration_date": "2019-08-24T14:15:22Z", "documentary_verification_documents_analysis_extracted_data_issuing_country": "string", "documentary_verification_documents_analysis_extracted_data_name": "string", "documentary_verification_documents_analysis_image_quality": "string", "documentary_verification_documents_analysis_redacted_at": "2019-08-24T14:15:22Z", "documentary_verification_documents_extracted_data_id_number": "string", "documentary_verification_documents_status": "string", "documentary_verification_extracted_data_documents_address_city": "string", "documentary_verification_extracted_data_documents_address_country": "string", "documentary_verification_extracted_data_documents_address_postal_code": 0, "documentary_verification_extracted_data_documents_address_region": "string", "documentary_verification_extracted_data_documents_address_street": "string", "documentary_verification_extracted_data_documents_date_of_birth": "2019-08-24T14:15:22Z", "documentary_verification_extracted_data_documents_expiration_date": "2019-08-24T14:15:22Z", "documentary_verification_extracted_data_documents_issuing_country": "string", "documentary_verification_extracted_documents_data_category": "string", "documentary_verification_images_cropped_back": "string", "documentary_verification_images_cropped_front": "string", "documentary_verification_images_face": "string", "documentary_verification_images_original_back": "string", "documentary_verification_images_original_front": "string", "documentary_verification_status": "string", "id": 0, "ip_address": "string", "kyc_check_address_po_box": "string", "kyc_check_address_summary": "string", "kyc_check_address_type": "string", "kyc_check_date_of_birth_summary": "string", "kyc_check_id_number_summary": "string", "kyc_check_name_summary": "string", "kyc_check_phone_number_area_code": "string", "kyc_check_phone_number_summary": "string", "kyc_check_status": "string", "last_updated_by": "string", "last_updated_on": "2019-08-24T14:15:22Z", "metadata": null, "plaid_completed_at": "2019-08-24T14:15:22Z", "plaid_created_at": "2019-08-24T14:15:22Z", "plaid_verification_id": "string", "previous_attempt_id": "string", "redacted_at": "2019-08-24T14:15:22Z", "risk_check_behavior_bot_detected": "string", "risk_check_behavior_devices_ip_proxy_type": "string", "risk_check_behavior_devices_ip_spam_list_count": 0, "risk_check_behavior_devices_ip_timezone_off": "string", "risk_check_behavior_devices_ip_timezone_offset": "string", "risk_check_behavior_email_breach_count": "string", "risk_check_behavior_email_domain_is_custom": "string", "risk_check_behavior_email_domain_is_disposable": "string", "risk_check_behavior_email_domain_is_free_provider": "string", "risk_check_behavior_email_domain_registered_at": "2019-08-24T14:15:22Z", "risk_check_behavior_email_first_breached_at": "2019-08-24T14:15:22Z", "risk_check_behavior_email_is_deliverable": "string", "risk_check_behavior_email_last_breached_at": "2019-08-24T14:15:22Z", "risk_check_behavior_email_linked_services": "string", "risk_check_behavior_email_tld_is_suspicious": "string", "risk_check_behavior_fraud_ring_detected": "string", "risk_check_behavior_phone_linked_services": "string", "risk_check_behavior_user_interactions": "string", "risk_check_identity_abuse_signals_stolen_identity_score": 0, "risk_check_identity_abuse_signals_synthetic_identity_score": 0, "risk_check_status": "string", "selfie_check_selfies_attempt": 0, "selfie_check_selfies_attempt_image_url": "string", "selfie_check_selfies_attempt_video_url": "string", "selfie_check_selfies_status": "string", "selfie_check_status": "string", "shareable_url": "string", "system_guid": "string", "template_id": "string", "template_version": 0, "udfs": null, "user_address_city": "string", "user_address_country": "string", "user_address_postal_code": 0, "user_address_region": "string", "user_address_street": "string", "user_address_street2": "string", "user_date_of_birth": "2019-08-24T14:15:22Z", "user_email_address": "string", "user_family_name": "string", "user_given_name": "string", "user_id_number_type": "string", "user_id_number_value": "string", "user_phone_number": 0, "user_status": "string", "user_steps_accept_tos": "string", "user_steps_documentary_verification": "string", "user_steps_kyc_check": "string", "user_steps_risk_check": "string", "user_steps_selfie_check": "string", "user_steps_verify_sms": "string", "user_steps_watchlist_screening": "string", "uuid": "string", "watchlist_screening_id": "string" } ] }

Request

Responses