Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt

Use this file to discover all available pages before exploring further.

The projection API can exclude full_name, gender, etc.For details, refer to this link.
{
    "webhook_trigger": "updated",
    "submission_id": "string",
    "duplicated_information": "string",
    "email": "string",
    "data": {
        "update": [
            "kycStatus",
            "idType",
            "issuingCountry",
            "fullName",
            "first_name",
            "last_name",
            "gender",
            "nationality",
            "birthDate",
            "identityNumber",
            "issueDate",
            "expireDate",
            "documentNumber",
            "serialNumber",
            "privacyShield",
            "curpNumber",
            "version",
            "typeOfPermit"
        ],
        "kyc_result": "string",
        "pending_at": "string",
        "reviewer": "string"
    },
    "admin": "string",
    "update_time": "string",
    "age_group": "string",
    "gender": "string",
    "date_of_birth": "string",
    "full_name": "string",
    "full_name_en": "string",
    "first_name" "string",
    "last_name" "string",
    "nationality": "string",
    "userid": "string",
    "tokenId": "string"
}
​
webhook_trigger
string
Webhook event type - updated indicates that user information has been updated.
​
submission_id
string
Unique identifier for each KYC submission.
​
duplicated_information
string
A unique ID is generated based on name, date of birth, gender, and nationality for duplicate checks. (*Always generated when all four criteria are provided.)
​
email
string
Email address of the KYC submitter.
​
data
object
An object containing the updated user data.
​
admin
string
Email of the administrator who performed the update via the dashboard.
​
update_time
string
Timestamp of the update (UTC+0, ISO 8601 format).
​
age_group
string
Age category of the submitter: minor: 13 years and under, early-teen: 14–15 years, teen: 16–17 years, adult: 18 years and older.
​
gender
string
Gender of the submitter (“male” or “female”).
​
date_of_birth
string
Submitter’s date of birth (YYYY-MM-DD format).
​
nationality
string
Submitter’s nationality (ISO 3166-1 alpha-3 country code).
​
userid
string
Unique identifier for the KYC submitter as defined by the client.
​
tokenId
string
Token ID used for submissions in private mode live forms.
​
full_name
string
Submitter’s full name
​
full_name_en
string
English Full Name provided after KYC approval. The name is processed through transliteration and not translated. Returns null if KYC is not approved or name has not been transliterated.
​
first_name
string
Submitter’s first name
​
last_name
string
Submitter’s last name (family name)
​
ssnNumber
string
Social Security Number.
* for applying the lowerCamelCase convention to the written Number once more.