Getting Started with WetDog
Welcome to the pack! Starting with WetDog is as easy as a walk in the park. This guide will have you fetching document recognition results with our API in no time. Let's get started and see how WetDog can streamline your document processing tasks.
Document Format Specification
Overview
The API renders the results in a standardized format to represent various types of official documents. This format is designed to help you quickly validate if you have received the right type of document or not.
Document Type
Documents are categorized in one of the following document types below. Note that the list is constantly being expanded. Please contact [email protected] to request for a new document type to be supported.
Important Legal disclaimer: recognition, NOT authentication
The WetDog API is designed to assist in recognizing document types and origins, and is not intended for validating the authenticity of documents. While it can confirm whether a user has uploaded a document that matches specified criteria, WetDog API does not have the capability to detect fake, altered, or tampered documents. It should not be used as a sole method for verifying the authenticity of any document.
For situations requiring certified or verified documents for legal purposes, users are advised to consult with specialized providers equipped to check for specific authenticity markers and document constituents. WetDog's primary function is to ensure that users have followed instructions in uploading the correct type of document, and it does not serve as a guarantee of the document's authenticity. Users relying on WetDog API for document recognition should be aware of its limitations and seek additional verification methods as necessary for their specific needs.
Supported Document Types
| Document | Example |
|---|---|
| Passport | Passport |
| Driver's License | DriversLicense |
| Birth Certificate | BirthCertificate |
| National ID Card | NationalID |
| Residence Permit | ResidencePermit |
| Work Permit | WorkPermit |
| Social Security Card | SocialSecurityCard |
| Marriage Certificate | MarriageCertificate |
| Immigration Document | ImmigrationDocument |
| Visa | Visa |
| Adoption Certificate | AdoptionCertificate |
| Educational Certificates/Diplomas | EducationalCertificate |
| Military ID Card | MilitaryID |
| Voter ID Card | VoterID |
| Tax Identification Number/Card | TaxID |
| Health Insurance Card | HealthInsuranceCard |
| Vehicle Registration Document | VehicleRegistration |
| Employment Authorization Document | EmploymentAuth |
| Refugee Travel Document | RefugeeTravelDoc |
| School Transcripts | SchoolTranscript |
Country Codes
WetDog uses the ISO 3166-1 alpha-2 Country Codes to standardize the representation of the country of origin for official documents. E.g. For the United Kingdom, use: GB, for Canada, use: CA, etc.
Responses
The API outputs results in a standardized format, ideal for quickly determining the type and origin of various official documents. Key elements include:
document_type: Categorizes the document into supported types (e.g., Passport, NationalID, WorkPermit). If unidentified, it returns "Unknown".
country: Indicates the document's country of origin, using ISO 3166-1 alpha-2 codes (e.g., GB for the United Kingdom, CA for Canada).
recognition_status: Presents one of three statuses: 'recognized' if both document type and country are identified, 'partially_recognized' if either is recognized, and 'unrecognized' if neither is determined.
No false positives
To enhance the reliability of our tool, we have prioritized the elimination of false positives over achieving absolute accuracy. This design approach ensures that when a document is classified as "recognized," users can confidently move to the next step. If the tool indicates recognition of a document type or country, the user can proceed with assurance that the information is highly credible and that therefore the intended document was indeed uplaoded. This careful balance minimizes the risk of erroneously accepting invalid documents, making it a trustworthy resource in the collection processes.
Updated 9 months ago
