MyazaIdentity
Sign inStart integrating

Get configuration

code
GET /api/kyc/config

Returns the ID types enabled for your organization in the current environment, along with the features available for each. Call this on startup to drive which ID options you present to users and which capture steps you run.

Authentication: Authorization: Bearer pk_… (required).

Request

shell
curl "https://identity.myaza.app/api/kyc/config" \
  -H "Authorization: Bearer $MYAZA_KEY"

Response 200 OK

json
{
  "environment": "PRODUCTION",
  "idTypes": [
    {
      "country": "NG",
      "idType": "bvn",
      "features": {
        "documentVerification": false,
        "livenessCheck": true,
        "govDbCheck": true
      }
    },
    {
      "country": "NG",
      "idType": "drivers-license",
      "features": {
        "documentVerification": true,
        "livenessCheck": true,
        "govDbCheck": true
      }
    }
  ],
  "branding": {
    "companyName": "Acme Inc.",
    "logo": "https://identity.myaza.app/api/kyc/branding/logo/ast_123",
    "primaryColor": "#5645F5"
  }
}

Fields

FieldTypeDescription
environmentstringSTAGING or PRODUCTION — derived from your API key.
idTypes[]arrayThe ID types enabled for your org. Disabled ones are omitted entirely.
idTypes[].countrystringISO country code: NG, GH, KE, ZA, CI.
idTypes[].idTypestringThe ID type identifier to send to POST /verify.
idTypes[].features.documentVerificationbooleanWhether document image capture is enabled for this ID type.
idTypes[].features.livenessCheckbooleanWhether a liveness/selfie step is enabled.
idTypes[].features.govDbCheckbooleanWhether the ID is checked against the government database.
brandingobjectYour organization's branding, set under Settings → Organization. May be omitted if nothing is configured.
branding.companyNamestringYour organization's display name.
branding.logostringAbsolute, public URL of your org logo. The SDKs render this when appearance.logo is set to 'default'. Omitted if no logo is uploaded.
branding.primaryColorstringYour org's brand color (hex), if set.

Only enabled ID types are returned. If an ID type you expect is missing, enable it under Settings → Organization → ID Types (or ask Myaza to enable it for your account).

See Countries & ID types for the catalog of supported values.