API changes: adding document_type

deriv_api_support · May 2023

Dear developers,

We’re adding the document_type property to the authentication.attempts.history and authentication.attempts.latest objects. This will be released in the week starting June 5.

API response before the change

{
"needs_verification": [],
"identity": {
    "status": "rejected",
    "services": {
        "onfido": {
            ...
        },
        "idv": {
            "submissions_left": 2,
            "last_rejected": [],
            "reported_properties": {},
            "status": "failed"
        },
        "manual": {
            ...
        }
    }
},
...
"attempts": {
    "count": 1,
    "history": [{
        "service": "idv",
        "status": "rejected",
        "country_code": "za",
        "id": "123",
        "timestamp": "20230427_154530"
    }],
    "latest": {
        "service": "idv",
        "status": "rejected",
        "country_code": "za",
        "id": "123",
        "timestamp": "20230427_154530"
    }
}
}

API response after the change

{
"needs_verification": [],
"identity": {
    "status": "rejected",
    "services": {
        "onfido": {
            ...
        },
        "idv": {
            "submissions_left": 2,
            "last_rejected": [],
            "reported_properties": {},
            "status": "failed"
        },
        "manual": {
            ...
        }
    }
},
...
"attempts": {
    "count": 1,
    "history": [{
        "service": "idv",
        "status": "rejected",
        "country_code": "za",
        "id": "123",
        "timestamp": "20230427_154530",
        "document_type": "national_id"
    }],
    "latest": {
        "service": "idv",
        "status": "rejected",
        "country_code": "za",
        "id": "123",
        "timestamp": "20230427_154530",
        "document_type": "national_id"
    }
}
}

The only change in the API response is the new document_type property.

Please make the necessary changes to your app(s) if needed.

If you have any questions, write to us at api-support@deriv.com.