# Get user KYC state

## <mark style="color:$success;">\[GET]</mark> /api/v2/user/kyc

Returns a KYC state of a user. It also returns KYC rules and available documents for the user’s country.

Request query params type:

```typescript
type QueryParams = {
    userEmail: string, //required
    countryIsoCode: string //required
}
```

Request URL example:

{% code overflow="wrap" %}

```
GET /api/v2/user/kyc?userEmail=testuser_ng@fonbnk.com&countryIsoCode=NG
```

{% endcode %}

Response type:

{% code overflow="wrap" expandable="true" %}

```typescript
type Response = {
  passedKycType?: KycType;
  reachedKycLimit: boolean;
  currentKycType?: KycType;
  currentKycStatus?: KycStatus;
  currentKycStatusDescription?: string;
  kycDocuments: KycDocument[],
  kycRules: {
    operationType: OperationType;
    currencyType: CurrencyType;
    min: number; // USD
    max: number | 'Infinity';
    type: KycType;
  }[]
}
```

{% endcode %}

Response example:

```json
{
    "passedKycType": "basic",
    "reachedKycLimit": false,
    "currentKycType": "basic",
    "currentKycStatus": "approved",
    "currentKycStatusDescription": "Exact Match",
    "kycDocuments": [
        {
            "_id": "67da93c0dfd3a00f3380b857",
            "title": "Driving License",
            "value": "DRIVERS_LICENSE",
            "type": "advanced",
            "requiredFields": [
                {
                    "key": "first_name",
                    "type": "string",
                    "label": "First Name",
                    "required": true
                },
                {
                    "key": "last_name",
                    "type": "string",
                    "label": "Last Name",
                    "required": true
                },
                {
                    "key": "dob",
                    "type": "date",
                    "label": "Date of birth",
                    "required": true
                },
                {
                    "key": "images",
                    "type": "smile-identity-images",
                    "label": "Verification images",
                    "required": true
                }
            ]
        },
        {
            "_id": "67da93c0dfd3a00f3380b859",
            "title": "National IDs, Consular IDs & Diplomat IDs",
            "value": "IDENTITY_CARD",
            "type": "advanced",
            "requiredFields": [
                {
                    "key": "first_name",
                    "type": "string",
                    "label": "First Name",
                    "required": true
                },
                {
                    "key": "last_name",
                    "type": "string",
                    "label": "Last Name",
                    "required": true
                },
                {
                    "key": "dob",
                    "type": "date",
                    "label": "Date of birth",
                    "required": true
                },
                {
                    "key": "images",
                    "type": "smile-identity-images",
                    "label": "Verification images",
                    "required": true
                }
            ]
        },
        {
            "_id": "67da93c0dfd3a00f3380b85b",
            "title": "Passports",
            "value": "PASSPORT",
            "type": "advanced",
            "requiredFields": [
                {
                    "key": "first_name",
                    "type": "string",
                    "label": "First Name",
                    "required": true
                },
                {
                    "key": "last_name",
                    "type": "string",
                    "label": "Last Name",
                    "required": true
                },
                {
                    "key": "dob",
                    "type": "date",
                    "label": "Date of birth",
                    "required": true
                },
                {
                    "key": "images",
                    "type": "smile-identity-images",
                    "label": "Verification images",
                    "required": true
                }
            ]
        },
        {
            "_id": "67da93c0dfd3a00f3380b85d",
            "title": "Registration certificate",
            "value": "REGISTRATION_CERTIFICATE",
            "type": "advanced",
            "requiredFields": [
                {
                    "key": "first_name",
                    "type": "string",
                    "label": "First Name",
                    "required": true
                },
                {
                    "key": "last_name",
                    "type": "string",
                    "label": "Last Name",
                    "required": true
                },
                {
                    "key": "dob",
                    "type": "date",
                    "label": "Date of birth",
                    "required": true
                },
                {
                    "key": "images",
                    "type": "smile-identity-images",
                    "label": "Verification images",
                    "required": true
                }
            ]
        },
        {
            "_id": "67da93c1dfd3a00f3380b85f",
            "title": "Residency permits, Refugee IDs & Residency cards",
            "value": "RESIDENT_ID",
            "type": "advanced",
            "requiredFields": [
                {
                    "key": "first_name",
                    "type": "string",
                    "label": "First Name",
                    "required": true
                },
                {
                    "key": "last_name",
                    "type": "string",
                    "label": "Last Name",
                    "required": true
                },
                {
                    "key": "dob",
                    "type": "date",
                    "label": "Date of birth",
                    "required": true
                },
                {
                    "key": "images",
                    "type": "smile-identity-images",
                    "label": "Verification images",
                    "required": true
                }
            ]
        },
        {
            "_id": "67da93c1dfd3a00f3380b861",
            "title": "Border crossing documents & Visas",
            "value": "TRAVEL_DOC",
            "type": "advanced",
            "requiredFields": [
                {
                    "key": "first_name",
                    "type": "string",
                    "label": "First Name",
                    "required": true
                },
                {
                    "key": "last_name",
                    "type": "string",
                    "label": "Last Name",
                    "required": true
                },
                {
                    "key": "dob",
                    "type": "date",
                    "label": "Date of birth",
                    "required": true
                },
                {
                    "key": "images",
                    "type": "smile-identity-images",
                    "label": "Verification images",
                    "required": true
                }
            ]
        },
        {
            "_id": "67da93c1dfd3a00f3380b863",
            "title": "Voter's Identity Card",
            "value": "VOTER_ID",
            "type": "advanced",
            "requiredFields": [
                {
                    "key": "first_name",
                    "type": "string",
                    "label": "First Name",
                    "required": true
                },
                {
                    "key": "last_name",
                    "type": "string",
                    "label": "Last Name",
                    "required": true
                },
                {
                    "key": "dob",
                    "type": "date",
                    "label": "Date of birth",
                    "required": true
                },
                {
                    "key": "images",
                    "type": "smile-identity-images",
                    "label": "Verification images",
                    "required": true
                }
            ]
        },
        {
            "_id": "67da909b739fc481aa525c43",
            "title": "Voter ID",
            "value": "VOTER_ID",
            "type": "basic",
            "requiredFields": [
                {
                    "key": "first_name",
                    "type": "string",
                    "label": "First Name",
                    "required": true
                },
                {
                    "key": "last_name",
                    "type": "string",
                    "label": "Last Name",
                    "required": true
                },
                {
                    "key": "dob",
                    "type": "date",
                    "label": "Date of birth",
                    "required": true
                },
                {
                    "key": "id_number",
                    "type": "string",
                    "label": "ID number",
                    "required": true,
                    "format": "0000000000000000000",
                    "regexp": "^[a-zA-Z0-9 ]{9,29}$",
                    "regexpFlags": "i"
                }
            ]
        },
        {
            "_id": "67da909b739fc481aa525c45",
            "title": "BVN",
            "value": "BVN",
            "type": "basic",
            "requiredFields": [
                {
                    "key": "first_name",
                    "type": "string",
                    "label": "First Name",
                    "required": true
                },
                {
                    "key": "last_name",
                    "type": "string",
                    "label": "Last Name",
                    "required": true
                },
                {
                    "key": "dob",
                    "type": "date",
                    "label": "Date of birth",
                    "required": true
                },
                {
                    "key": "id_number",
                    "type": "string",
                    "label": "BVN Number",
                    "required": true,
                    "format": "00000000000",
                    "regexp": "^[0-9]{11}$"
                }
            ]
        },
        {
            "_id": "67da909b739fc481aa525c47",
            "title": "NIN V2",
            "value": "NIN_V2",
            "type": "basic",
            "requiredFields": [
                {
                    "key": "first_name",
                    "type": "string",
                    "label": "First Name",
                    "required": true
                },
                {
                    "key": "last_name",
                    "type": "string",
                    "label": "Last Name",
                    "required": true
                },
                {
                    "key": "dob",
                    "type": "date",
                    "label": "Date of birth",
                    "required": true
                },
                {
                    "key": "id_number",
                    "type": "string",
                    "label": "NIN V2 Number",
                    "required": true,
                    "format": "00000000000",
                    "regexp": "^[0-9]{11}$"
                }
            ]
        },
        {
            "_id": "67da909b739fc481aa525c49",
            "title": "NIN SLIP",
            "value": "NIN_SLIP",
            "type": "basic",
            "requiredFields": [
                {
                    "key": "first_name",
                    "type": "string",
                    "label": "First Name",
                    "required": true
                },
                {
                    "key": "last_name",
                    "type": "string",
                    "label": "Last Name",
                    "required": true
                },
                {
                    "key": "dob",
                    "type": "date",
                    "label": "Date of birth",
                    "required": true
                },
                {
                    "key": "id_number",
                    "type": "string",
                    "label": "NIN SLIP Number",
                    "required": true,
                    "format": "00000000000",
                    "regexp": "^[0-9]{11}$"
                }
            ]
        },
        {
            "_id": "67da909b739fc481aa525c4b",
            "title": "Drivers license",
            "value": "DRIVERS_LICENSE",
            "type": "basic",
            "requiredFields": [
                {
                    "key": "first_name",
                    "type": "string",
                    "label": "First Name",
                    "required": true
                },
                {
                    "key": "last_name",
                    "type": "string",
                    "label": "Last Name",
                    "required": true
                },
                {
                    "key": "dob",
                    "type": "date",
                    "label": "Date of birth",
                    "required": true
                },
                {
                    "key": "id_number",
                    "type": "string",
                    "label": "ID number",
                    "required": true,
                    "regexp": "^[a-zA-Z]{3}([ -]{1})?[A-Z0-9]{6,12}$",
                    "regexpFlags": "i",
                    "format": "ABC000000000"
                }
            ]
        }
    ],
    "kycRules": [
        {
            "operationType": "deposit",
            "currencyType": "fiat",
            "min": 2,
            "max": 20,
            "type": "basic"
        },
        {
            "operationType": "deposit",
            "currencyType": "fiat",
            "min": 20,
            "max": "Infinity",
            "type": "advanced"
        },
        {
            "operationType": "deposit",
            "currencyType": "crypto",
            "min": 2,
            "max": 20,
            "type": "basic"
        },
        {
            "operationType": "deposit",
            "currencyType": "crypto",
            "min": 20,
            "max": "Infinity",
            "type": "advanced"
        }
    ]
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fonbnk.com/server-to-server/api-endpoints/get-user-kyc-state.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.