Onfido Mappings

The Onfido mappings match the field names as returned by the Onfido processor (keys) with the populated entities' attributes (values).

Setting Name Description
DocumentsMapping Holds attribute mappings for various types of scanned documents.
Type Scanned document type.
Map Key-value pairs that match the field name as returned by the Onfido processor (the key) to the attribute name in the destination entity (the value).

Example

The side parameter indicates which side of the identity document the field belongs to. For one-sided documents, set it to front for all attributes.

Copy 
{
    "DocumentsMapping":
    [
        {
            "type": "IdRom",
            "Map":
            {
                "LastName": { "attribute": "lastName", "side": "front" },
                "GivenName": { "attribute": "firstName", "side": "front" },
                "FullName": { "attribute": "fullName", "side": "back" },
                "SpouseName": { "attribute": "spouseName", "side": "back" },
                "WidowName": { "attribute": "widowName", "side": "back" },
                "AliasName": { "attribute": "aliasName", "side": "back" },
                "TypeOfDocument": { "attribute": "typeOfDocument", "side": "back" },
                "DocumentNumber": { "attribute": "IdCardSeries", "side": "front" },
                "StreetType": { "attribute": "streetType", "side": "front" },
                "PersonalNumber": { "attribute": "PIN", "side": "front" },
                "BirthDate": { "attribute": "dateOfBirth", "side": "front" },
                "PlaceOfBirthBody": { "attribute": "placeOfBirth", "side": "front" },
                "BirthCountryBody": { "attribute": "birthCountry", "side": "front" },
                "Address": { "attribute": "fullAddress", "side": "front" },
                "Sex": { "attribute": "gender", "side": "front" },
                "DistrictCode": { "attribute": "DistrictId", "side": "front" },
                "Nationality": { "attribute": "nationality", "side": "front" },
                "IssuedBy": { "attribute": "IssueInstitution", "side": "front" },
                "IssuedAt": { "attribute": "IdIssueDate", "side": "front" },
                "IssuedUntil": { "attribute": "IdExpirationDate", "side": "front" },
                "IssuingCountry": { "attribute": "isuingCountry", "side": "front" },
                "Confidence": { "attribute": "confidence", "side": "front" },
                "mrz_line1": { "attribute": "mrz_line1", "side": "front" },
                "mrz_line2": { "attribute": "mrz_line2", "side": "front" },
                "mrz_line3": { "attribute": "mrz_line3", "side": "front" },
                "AddressLine1": { "attribute": "AddressLine1", "side": "front" },
                "AddressLine2": { "attribute": "AddressLine2", "side": "front" },
                "AddressLine3": { "attribute": "AddressLine3", "side": "front" },
                "AddressLine4": { "attribute": "AddressLine4", "side": "front" },
                "AddressLine5": { "attribute": "AddressLine5", "side": "front" }
            }
        }
    ]
}

 

NOTE  
By default, Onfido document pictures are saved on Onfido Events, inside FTOS_Onfido_CheckReport. If you’d like to store the document pictures in picture attribute on applicant / retail applicant business entities, you can develop a trigger to save them there as well. Otherwise, PictureAttribute from Applicant / retail applicant business entity is not used by default for Onfido.