API Reference
Log inSign up
v1.7.3
v1.7.3
  • ComplyCube API Reference
  • Integration
  • Test and Live
  • Authentication
  • Rate Limits
  • Service Quota
  • Errors
  • Pagination
  • Filtering
  • Versioning
  • Core resources
    • Clients
      • Create a client
      • Get a client
      • Update a client
      • Delete a client
      • List clients
      • Filtering clients
    • Addresses
      • Create an address
      • Get an address
      • Update an address
      • Delete an address
      • List addresses
      • Filtering addresses
    • Documents
      • Create a document
      • Get a document
      • Update a document
      • Upload image attachment
      • Delete image attachment
      • Download image attachment
      • Redact image attachment
      • Delete a document
      • List documents
      • Filtering documents
    • Live Photos
      • Upload a live photo
      • Get a live photo
      • Download live photo
      • Redact live photo
      • Delete a live photo
      • List live photos
    • Live Videos
      • Get a live video
      • Redact live video
      • Delete live video
      • List live videos
    • Checks
      • Create a check
      • Get a check
      • Update a check
      • Validate check outcome
      • Redact check outcome
      • List checks
      • Filtering checks
    • Risk Profile
      • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
    • Enhanced Identity Check
    • Proof of Address Check
    • Multi-Bureau Check
    • Face Authentication Check
    • Age Estimation Check
  • Lookups
    • Company Search
      • Search company
      • Get company details
    • Address Search
      • Search address
  • Tools
    • Custom Lists
      • Get a custom list
      • Add entity to custom list
      • List custom lists
  • Static Data
    • Screening Lists
    • Supported Documents
  • Other Resources
    • Flow (Hosted Solution)
      • Create a session
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • SDK Tokens
      • Generate a token
    • Autofill
      • Perform autofill
    • Reports
      • Generate a client report
      • Generate a check report
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
    • Account Info
      • Get account info
  • Useful Resources
    • Testing Data
    • User Docs
Powered by GitBook
On this page
  • URL
  • Headers
  • Body
  • Example request
  • Example responses

Was this helpful?

  1. Other Resources
  2. Autofill

Perform autofill

PreviousAutofillNextReports

Last updated 1 year ago

Was this helpful?

Extracts data and images from an identity document.

URL

POST https://api.complycube.com/v1/autofill

Headers

Name
Type
Description

Authorization*

string

The API live or test key.

Content-Type*

string

The content-type must always be set to application/json.

Body

Name
Type
Description

data*

string

The BASE64 encoded data.

The response will include the following constituents:

Example request

curl -X POST https://api.complycube.com/v1/autofill \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
	       "data": "<BASE64_DATA_CONTENT>"
        }'
const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const supportedDocuments = await complycube.autofill.performAutofill({
    data: "BASE64_DATA_CONTENT"
});

Example responses

{
  "extractedData": {
    "holderDetails": {
      "lastName": [
        "MUSTERMANN"
      ],
      "firstName": [
        "ERIKA"
      ],
      "dob": {
        "day": 12,
        "month": 8,
        "year": 1964
      },
      "age": 57,
      "nationality": "DE",
      "birthPlace": "BERLIN",
      "gender": "female"
    },
    "documentDetails": {
      "documentNumber": "C01X0006H",
      "documentType": "passport",
      "issuingCountry": "DE",
      "issuingAuthority": "STADT KÖLN",
      "issuingDate": {
        "day": 1,
        "month": 11,
        "year": 2007
      },
      "expirationDate": {
        "day": 31,
        "month": 10,
        "year": 2017
      },
      "hasTwoSides": false
    },
    "allExtractedData": {
      "visual": {
        "lastName": [
          "MUSTERMANN"
        ],
        "lastNameNative": "MUSTERMANN",
        "firstName": [
          "ERIKA"
        ],
        "firstNameNative": "ERIKA",
        "entityNameNative": "MUSTERMANN ERIKA",
        "dob": {
          "day": 12,
          "month": 8,
          "year": 1964
        },
        "nationalityNative": "DEUTSCH",
        "birthPlace": "BERLIN",
        "birthPlaceNative": "BERLIN",
        "gender": "female",
        "documentNumber": "C01X0006H",
        "issuingCountry": "DE",
        "issuingAuthority": "STADT KÖLN",
        "issuingAuthorityNative": "STADT KÖLN",
        "issuingDate": {
          "day": 1,
          "month": 11,
          "year": 2007
        },
        "expirationDate": {
          "day": 31,
          "month": 10,
          "year": 2017
        }
      },
      "mrz": {
        "lastName": [
          "MUSTERMANN"
        ],
        "firstName": [
          "ERIKA"
        ],
        "dob": {
          "day": 12,
          "month": 8,
          "year": 1964
        },
        "nationality": "DE",
        "gender": "female",
        "documentNumber": "C01X0006H",
        "issuingCountry": "DE",
        "expirationDate": {
          "day": 31,
          "month": 10,
          "year": 2017
        }
      }
    },
    "mrz": {
      "line1": "P<D<<MUSTERMANN<<ERIKA<<<<<<<<<<<<<<<<<<<<<<",
      "line2": "C01X0006H1D<<6408125F1710319<<<<<<<<<<<<<<<0"
    }
  },
  "extractedImages": [
    {
      "type": "front_side",
      "data": "<BASE64_DATA_CONTENT>"
    }
  ]
}
{
    "type": 'document_type_undetected', 
    "message": 'Document type not recognized'
}
extractedData
extractedImages