{"openapi":"3.0.0","info":{"version":"2.0","title":"verification","description":"The verification API defines endpoints for initiating, confirming, and fetching details  of micro deposit transactions to verify bank accounts in the US and Canada.","contact":{"name":"API Support","email":"help@vopay.com"}},"paths":{"/account-verification/bank-account/initiate":{"post":{"description":"This endpoint is used to intiate the micro deposit transaction. The bank routing information required will vary depending on the country. Currently only US and Canada are supported.","summary":"account-verification/bank-account/initiate","tags":["Account Verification Endpoints"],"operationId":"AccountVerificationInitiate","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"Country":{"description":"Country for which the Micro Transaction should be initiated","type":"string"},"CompanyName":{"description":"Company name of the account holder - required for associating the bank details","type":"string"},"FirstName":{"description":"First name of the account holder - required for associating the bank details (optional if company name is present)","type":"string"},"LastName":{"description":"Last name of the account holder - required for associating the bank details (optional if company name is present)","type":"string"},"Notes":{"description":"An optional note to associate with the account verification request.","type":"string"},"ClientReferenceNumber":{"description":"Reference number for the client","type":"string"},"InstitutionNumber":{"description":"Financial Institution number - required for associating the bank details. Canada only.","type":"string"},"TransitNumber":{"description":"Bank transit number - required for associating the bank details. Canada only.","type":"string"},"AccountNumber":{"description":"Account number - required for associating the bank details.","type":"string"},"ABARoutingNumber":{"description":"ABA routing number - required for associating the bank details. US only.","type":"string"},"SendEmail":{"description":"This option is used to send the account verification initiation/expiration email. If you wish to send an email, then provide true. The default value is false.","type":"boolean"},"SenderEmailAddress":{"description":"Account's email address - Must be a valid email. Required if SendEmail = true","type":"string","format":"email"},"ReceiverEmailAddress":{"description":"Recipient's email address - Must be a valid email. Required if SendEmail = true","type":"string","format":"email"},"PhoneNumber":{"description":"Customer's phone number. Digits only - no parentheses or dashes allowed. US only.","type":"string"},"Address1":{"description":"Customer's address line 1. US only.","type":"string"},"City":{"description":"Account's city - No abbreviation. US only.","type":"string"},"State":{"description":"Customer's state specified using two character abbreviations (eg. CA, AZ). US only.","type":"string"},"ZipCode":{"description":"Customer's zip code. US only.","type":"string"},"Token":{"description":"The token identifying the bank account to be verified. If token is provided, bank routing info and address are not required.","type":"string"}},"required":["AccountID","Key","Signature","Country","CompanyName","FirstName","LastName","AccountNumber"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"VerificationRequestID":{"type":"integer","description":"Verification Request ID for the Bank Account to be verified","example":"1"},"Link":{"type":"string","description":"Link associated with the Account Verification Request ID","example":"https://embed.vopay.com/rtzcel1puxjd2ppyg3vlujggk2u52hzcv99eso14"}}}}}}}}},"/account-verification/bank-account/confirm":{"post":{"description":"This endpoint is used to confirm the micro deposit transaction.","summary":"account-verification/bank-account/confirm","tags":["Account Verification Endpoints"],"operationId":"AccountVerificationConfirm","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"VerificationRequestID":{"description":"Value of the Account Verification Request ID","type":"integer"},"Amount":{"description":"Amount to be confirmed for the Account Verification Request ID","type":"integer"}},"required":["AccountID","Key","Signature","VerificationRequestID","Amount"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"ConfirmationStatus":{"type":"integer","description":"Status of the confirmation","example":"true"}}}}}}}}},"/account-verification/card":{"post":{"description":"This endpoint is used to verify a credit or debit card.","summary":"account-verification/card","tags":["Account Verification Endpoints"],"operationId":"AccountVerificationCard","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"VerificationTier":{"description":"Tier of the verification request. Options are 'basic' and 'enhanced'. Defaults to 'basic' if not specified.","type":"string"},"CardToken":{"description":"The token identifying the credit or debit card","type":"string"}},"required":["AccountID","Key","Signature","CardToken"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"VerificationRequestID":{"type":"integer","description":"Verification Request ID for the Bank Account to be verified","example":"1234"},"VerificationStatus":{"type":"string","description":"Status of the verification","example":"Verified"},"VerificationInfo":{"type":"object","description":"Verification information for the request (enhanced only)","properties":{"0":{"type":"object","properties":{"SendingEligibility":{"type":"string","description":"This debit card's eligibility to send funds.","example":"1"},"ReceivingEligibility":{"type":"string","description":"This debit card's eligibility to receive funds.","example":"1"},"Type":{"type":"string","description":"Verified card type.","example":"debit"},"Brand":{"type":"string","description":"Verified card brand.","example":"mastercard"},"FundsAvailability":{"type":"string","description":"Funds availability time frame after receiving a payment transaction.","example":"immediate"},"InstitutionName":{"type":"string","description":"Financial institution name.","example":"bankcorp bank, the"},"InstitutionCountry":{"type":"string","description":"Financial institution country.","example":"usa"},"AccountStatementCurrency":{"type":"string","description":"Currency of cardholder's account statement","example":"usd"},"AcceptanceBrand":{"type":"string","description":"Acceptance Brand","example":"mcc"},"ProductType":{"type":"string","description":"Product Type","example":"consumer"}}}}}}}}}}}}},"/account-verification/interac":{"post":{"description":"This endpoint is used to verify an Interac email address.","summary":"account-verification/interac","tags":["Account Verification Endpoints"],"operationId":"AccountVerificationInterac","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"VerificationTier":{"description":"Tier of the verification request. Options are 'basic' and 'enhanced'. Defaults to 'basic' if not specified.","type":"string"},"EmailAddress":{"description":"Email address of the account holder","type":"string"},"AccountHolderName":{"description":"Name of the account holder - required for associating the email address (not required if ClientAccountID/ContactID is present)","type":"string"},"ClientAccountID":{"description":"Client account ID - required for associating the email address (not required if AccountHolderName is present)","type":"string"},"ContactID":{"description":"Contact ID - required for associating the email address (not required if AccountHolderName is present)","type":"string"}},"required":["AccountID","Key","Signature","EmailAddress"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"VerificationRequestID":{"type":"integer","description":"Verification Request ID for the Bank Account to be verified","example":"1234"},"VerificationStatus":{"type":"string","description":"Status of the verification","example":"Verified"},"RegistrationInfo":{"type":"object","description":"Registration information for the verification request (enhanced only)","example":{"registeredName":"Johnathan M Rogers","alias":"John Rogers","autoDepositEnabled":true,"customerType":"RETAIL","maxPaymentOutgoingAmount":"25000"}}}}}}}}}},"/account-verification":{"get":{"description":"This endpoint is used to fetch the details of a micro deposit transaction.","summary":"account-verification","tags":["Account Verification Endpoints"],"operationId":"AccountVerification","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"VerificationRequestID","in":"query","required":true,"description":"Value of the Account Verification Request ID","schema":{"type":"integer"}},{"name":"RequestStatus","in":"query","required":false,"description":"The account verification request status. Can be 'active' or 'expired'","schema":{"type":"string"}},{"name":"VerificationStatus","in":"query","required":false,"description":"The vefification status of the account. Can be 'unverified', 'verified' or 'failed'","schema":{"type":"string"}},{"name":"VerificationType","in":"query","required":false,"description":"The verification type. Can be 'bank' or 'interac'","schema":{"type":"string"}},{"name":"SearchText","in":"query","required":false,"description":"A text string to search for in the email addresses used for Account Verification process.","schema":{"type":"string"}},{"name":"StartDateTime","in":"query","required":false,"description":"Return micro deposit transactions that occurred on or after this date/time. Can be specified in either YYYY-MM-DD HH:MM:SS or YYYY-MM-DD format.","schema":{"type":"string","format":"date-time"}},{"name":"EndDateTime","in":"query","required":false,"description":"Return micro deposit transactions that occurred on or before this date/time. Can be specified in either YYYY-MM-DD HH:MM:SS or YYYY-MM-DD format.","schema":{"type":"string","format":"date-time"}},{"name":"Limit","in":"query","required":false,"description":"Limit the number of records that are returned.","schema":{"type":"integer"}},{"name":"Offset","in":"query","required":false,"description":"Use this parameter to set the starting point in the dataset.","schema":{"type":"integer"}},{"name":"Timezone","in":"query","required":false,"description":"Use this parameter to convert the time to the specified timezone. If no timezone is specified, the default is UTC.","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"ClientAccountID":{"type":"string","description":"The client account ID.","example":"johndoe"},"VerificationRequestID":{"type":"integer","description":"Your updated Account Verification Request ID","example":"1"},"AccountHolderName":{"type":"string","description":"Account holder name associated with the Account Verification Request ID","example":"John Smith"},"VerificationType":{"type":"string","description":"The verification type. Can be 'bank' or 'interac'","example":"bank"},"Amount":{"type":"integer","description":"Amount associated with the Account Verification Request ID","example":"0.22"},"Details":{"type":"object","description":"Bank account details associated with the Account Verification Request ID","properties":{"Credit":{"type":"object","description":"Name associated with the credit transaction","properties":{"FirstName":{"type":"string","description":"First name associated with the credit transaction","example":"John"},"LastName":{"type":"string","description":"Last name associated with the credit transaction","example":"Smith"},"CreditCardToken":{"type":"string","description":"Credit card token","example":"a022ff77a55e6d00bf271a2b36c65a26600a1a25"},"CreditCardBrand":{"type":"string","description":"Credit card brand","example":"mastercard"},"CreditCardNumber":{"type":"string","description":"Masked credit card number","example":"***********4567"}}},"Debit":{"type":"object","description":"Name associated with the debit transaction","properties":{"FirstName":{"type":"string","description":"First name associated with the debit transaction","example":"John"},"LastName":{"type":"string","description":"Last name associated with the debit transaction","example":"Smith"},"DebitCardToken":{"type":"string","description":"Debit card token","example":"a022ff77a55e6d00bf271a2b36c65a26600a1a25"},"DebitCardBrand":{"type":"string","description":"Debit card brand","example":"mastercard"},"DebitCardNumber":{"type":"string","description":"Masked debit card number","example":"***********4567"}}},"Bank":{"type":"object","description":"Bank account number associated with the Account Verification Request ID","properties":{"AccountNumber":{"type":"string","description":"Bank account number associated with the Account Verification Request ID","example":"123456789"},"Currency":{"type":"string","description":"Currency of the bank account associated with the Account Verification Request ID","example":"USD"}}},"EmailAddress":{"type":"object","description":"Email address associated with the Account Verification Request ID","properties":{"AccountHolderName":{"type":"string","description":"Account holder name associated with the Account Verification Request ID","example":"John Smith"},"EmailAddress":{"type":"string","description":"Email address associated with the Account Verification Request ID","example":"john.smith@example.com"}}}}},"PaymentRail":{"type":"string","description":"The payment rail used for the verification transaction","example":"ACH Withdrawal"},"Status":{"type":"object","description":"Statuses associated with the Account Verification Request ID","properties":{"Transaction":{"type":"object","description":"Transaction statuses associated with the Account Verification Request ID","properties":{"Credit":{"type":"string","description":"Credit transaction status associated with the Account Verification Request ID","example":"in progress"},"Debit":{"type":"string","description":"Debit transaction status associated with the Account Verification Request ID","example":"in progress"}}},"Verification":{"type":"string","description":"Verification status associated with the Account Verification Request ID","example":"unverified"},"Request":{"type":"string","description":"Request status associated with the Account Verification Request ID","example":"unverified"}}},"VerificationAttempts":{"type":"integer","description":"Verification attempt count associated with the Account Verification Request ID","example":"0"},"EmailAddress":{"type":"object","description":"Email addresses associated with the Account Verification Request ID","properties":{"Sender":{"type":"string","description":"Account's Email Address associated with the Account Verification Request ID","example":""},"Receiver":{"type":"string","description":"Recipient's Email Address associated with the Account Verification Request ID","example":""}}},"Link":{"type":"string","description":"Link associated with the Account Verification Request ID","example":"https://request-dev.vopay.com/?AccountVerificationToken=1sqzvv"},"Notes":{"type":"string","description":"Note associated with the Account Verification Request ID","example":"This is a note"},"LastModified":{"type":"string","format":"date-time","description":"Last modified date/time associated with the Account Verification Request ID","example":"2019-01-01 00:00:00"},"Pagination":{"type":"object","description":"Pagination metadata","properties":{"TotalRecords":{"type":"string","description":"Total number of transaction records in that search range.","example":"1000"},"Offset":{"type":"string","description":"Use this parameter to set the starting point in the dataset.","example":"1000"},"Limit":{"type":"string","description":"Limit the number of records that are returned.","example":"1000"}}}}}}}}}}},"/contact-verification/email":{"post":{"description":"This endpoint is used to intiate an email verification.","summary":"contact-verification/email","tags":["Contact Verification Endpoints"],"operationId":"ContactVerificationEmail","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"The client account ID associated with this email. This is required if client account is enabled. Use ContactID instead if client account is not enabled.","type":"string"},"ContactID":{"description":"The contact ID associated with this email. This is required if client account is not enabled. Use ClientAccountID instead if client account is enabled.","type":"string"},"EmailAddress":{"description":"Email address to be verified - Must be a valid email","type":"string","format":"email"},"VerificationTier":{"description":"Tier of the verification request. Options are 'basic' and 'enhanced'. Defaults to 'basic' if not specified.","type":"string"}},"required":["AccountID","Key","Signature","ClientAccountID","ContactID","EmailAddress"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"VerificationRequestID":{"type":"integer","description":"Verification Request ID for the Email to be verified","example":"123"}}}}}}}}},"/contact-verification/email/confirm":{"post":{"description":"This endpoint is used to confirm an email verification using an OTP sent to the email address.","summary":"contact-verification/email/confirm","tags":["Contact Verification Endpoints"],"operationId":"ContactVerificationEmailConfirm","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"Token":{"description":"The single-use token associated with the email verification request","type":"string"},"OTP":{"description":"The one-time password sent to the email address to be verified","type":"string"}},"required":["Token","OTP"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"VerificationStatus":{"type":"string","description":"Status of the verification. Can be 'verified' or 'failed'.","example":"verified"}}}}}}}}},"/contact-verification/phone":{"post":{"description":"This endpoint is used to intiate an phone SMS verification.","summary":"contact-verification/phone","tags":["Contact Verification Endpoints"],"operationId":"ContactVerificationPhone","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"The client account ID associated with this phone number. This is required if client account is enabled. Use ContactID instead if client account is not enabled.","type":"string"},"ContactID":{"description":"The contact ID associated with this phone number. This is required if client account is not enabled. Use ClientAccountID instead if client account is enabled.","type":"string"},"PhoneNumber":{"description":"Phone number to be verified - Must be a valid phone number","type":"string"},"VerificationTier":{"description":"Tier of the verification request. Options are 'basic' and 'enhanced'. Defaults to 'basic' if not specified.","type":"string"}},"required":["AccountID","Key","Signature","ClientAccountID","ContactID","PhoneNumber"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"VerificationRequestID":{"type":"integer","description":"Verification Request ID for the Phone to be verified","example":"123"}}}}}}}}},"/contact-verification/phone/confirm":{"post":{"description":"This endpoint is used to confirm a phone verification using an OTP sent via SMS.","summary":"contact-verification/phone/confirm","tags":["Contact Verification Endpoints"],"operationId":"ContactVerificationPhoneConfirm","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"Token":{"description":"The single-use token associated with the phone verification request","type":"string"},"OTP":{"description":"The one-time password sent via SMS to the phone number to be verified","type":"string"}},"required":["Token","OTP"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"VerificationStatus":{"type":"string","description":"Status of the verification. Can be 'verified' or 'failed'.","example":"verified"}}}}}}}}},"/contact-verification/id/non-doc":{"post":{"description":"This endpoint is used to perform Non-Document ID verification on an individual. Currently only Canada is supported.","summary":"contact-verification/id/non-doc","tags":["Contact Verification Endpoints"],"operationId":"ContactVerificationIDNonDoc","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"The client account ID to verify. This is required if client account is enabled. Use ContactID instead if client account is not enabled.","type":"string"},"ContactID":{"description":"The contact ID of the contact to verify. This is required if client account is not enabled. Use ClientAccountID instead if client account is enabled.","type":"string"},"FullName":{"description":"Contact's full name","type":"string"},"DOB":{"description":"Date of Birth, in date format YYYY-MM-DD (ex: 1960-01-15).","type":"string"},"EmailAddress":{"description":"Email address of the contact - Must be a valid email","type":"string","format":"email"},"Address1":{"description":"Contact's address line 1","type":"string"},"Address2":{"description":"Contact's address line 2","type":"string"},"City":{"description":"Contact's city","type":"string"},"Province":{"description":"Contact's province specified using two character abbreviations (eg. BC, AB)","type":"string"},"PostalCode":{"description":"Contact's postal code","type":"string"},"Country":{"description":"Contact's country specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.","type":"string"},"TriggerAMLCheck":{"description":"Include an AML check if the dual process verification status is verified.","type":"boolean"},"TriggerManualIDVOnFailure":{"description":"If the non-document verification status is not verified then initiate a manual ID verification request to the email provided above.","type":"boolean"}},"required":["AccountID","Key","Signature","ClientAccountID","ContactID","FullName","DOB","EmailAddress","Address1","City","Province","PostalCode","Country"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"VerificationRequestID":{"type":"integer","description":"Verification Request ID for the contact to be verified","example":"123"},"VerificationStatus":{"type":"string","description":"Status of the verification","example":"Verified"}}}}}}}}},"/contact-verification/generate-embed-url":{"post":{"description":"This endpoint generates an embed URL for contact verification. The URL can be used to embed a verification iframe for address, basic ID, or enhanced ID verification.","summary":"contact-verification/generate-embed-url","tags":["Contact Verification Endpoints"],"operationId":"ContactVerificationGenerateEmbedUrl","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"The client account ID to generate the embed URL for. This is required if client account is enabled. Use ContactID instead if client account is not enabled.","type":"string"},"ContactID":{"description":"The contact ID to generate the embed URL for. This is required if client account is not enabled. Use ClientAccountID instead if client account is enabled.","type":"string"},"VerificationType":{"description":"The type(s) of verification to embed. Must be one or more of: 'address', 'idbasic', 'idenhanced'. Multiple values can be comma-separated.","type":"string"},"StylesheetUrl":{"description":"URL of a custom stylesheet to apply to the embedded verification iframe","type":"string"},"Language":{"description":"The language preference for the embed. Defaults to 'en'.","type":"string"}},"required":["AccountID","Key","Signature","ClientAccountID","ContactID","VerificationType"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"Link":{"type":"string","description":"The generated embed URL","example":"https://earthnode-dev.vopay.com/contact-verification?Token=abc123"},"SingleUseToken":{"type":"string","description":"Single-use token used to generate the embed URL","example":"abc123"}}}}}}}}},"/contact-verification/name-screen":{"post":{"description":"This endpoint is used to verify contacts name","summary":"contact-verification/name-screen","tags":["Contact Verification Endpoints"],"operationId":"ContactVerificationNameScreen","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"The client account ID associated with this name. This is required if client account is enabled. Use ContactID instead if client account is not enabled.","type":"string"},"ContactID":{"description":"The contact ID associated with this name. This is required if client account is not enabled. Use ClientAccountID instead if client account is enabled.","type":"string"},"Country":{"description":"Contact's country specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.","type":"string"}},"required":["AccountID","Key","Signature","ClientAccountID","ContactID","Country"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"VerificationRequestID":{"type":"integer","description":"Verification Request ID for the contact name screening request","example":"123"},"VerificationStatus":{"type":"string","description":"Status of the verification","example":"verified"}}}}}}}}},"/contact-verification":{"get":{"description":"This endpoint is used to fetch results of the contact verification requests.","summary":"contact-verification/requests","tags":["Contact Verification Endpoints"],"operationId":"ContactVerificationRequestsGet","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"VerificationRequestID","in":"query","required":false,"description":"Value of the Contact Verification Request ID","schema":{"type":"integer"}},{"name":"ClientAccountID","in":"query","required":true,"description":"The client account ID associated with this email. This is required if client account is enabled. Use ContactID instead if client account is not enabled.","schema":{"type":"string"}},{"name":"ContactID","in":"query","required":true,"description":"The contact ID associated with this email. This is required if client account is not enabled. Use ClientAccountID instead if client account is enabled.","schema":{"type":"string"}},{"name":"SearchText","in":"query","required":false,"description":"A text string to search for in the email addresses used for Account Verification process.","schema":{"type":"string"}},{"name":"Limit","in":"query","required":false,"description":"Limit the number of records that are returned.","schema":{"type":"integer"}},{"name":"Offset","in":"query","required":false,"description":"Use this parameter to set the starting point in the dataset.","schema":{"type":"integer"}},{"name":"VerificationType","in":"query","required":false,"description":"Filter by contact verification type. Can be 'email', 'phone', 'nondoc', 'name'.","schema":{"type":"string"}},{"name":"VerificationTier","in":"query","required":false,"description":"filter by tier of the verification request. Options are 'basic' and 'enhanced'.","schema":{"type":"string"}},{"name":"VerificationStatus","in":"query","required":false,"description":"filter by Status of the verification request. Options are 'unverified', 'verified', 'failed'.","schema":{"type":"string"}},{"name":"Timezone","in":"query","required":false,"description":"Use this parameter to convert the time to the specified timezone. If no timezone is specified, the default is UTC.","schema":{"type":"string"}},{"name":"StartDateTime","in":"query","required":false,"description":"Return contact verification requests that occurred on or after this date/time. Can be specified in either YYYY-MM-DD HH:MM:SS or YYYY-MM-DD format.","schema":{"type":"string","format":"date-time"}},{"name":"EndDateTime","in":"query","required":false,"description":"Return contact verification requests that occurred on or before this date/time. Can be specified in either YYYY-MM-DD HH:MM:SS or YYYY-MM-DD format.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"ContactVerificationRequests":{"type":"object","description":"Contact verification requests results","properties":{"0":{"type":"object","properties":{"ClientAccountID":{"type":"string","description":"Client account ID","example":"johndoe"},"Type":{"type":"string","description":"Contact verification type","example":"address"},"VerificationStatus":{"type":"string","description":"Status of the verification request","example":"verified"},"LastModified":{"type":"string","description":"Last modified date/time associated with the Account Verification Request ID","example":"2025-10-30 00:08:27"}}}}}}}}}}}}}},"servers":[{"url":"https://earthnode-dev.vopay.com/api/v2"}]}