Skip to main content

Get KYC Profile

GET 
/api/accounts/:accountId/kyc-profile

Get a KYC profile by account id if it exists.

Request​

Path Parameters

    accountId stringrequired

    Id of the cardholder or identity account.

    Example: 225d85e65495722bf6517ea0ba0d6f56

Query Parameters

    includePersonalDetails boolean

    Include personal details (name, date of birth, etc) in the response. Requires additional permissions.

Responses​

Schema

    id string

    The KYC profile id.

    accountId string

    The account id.

    status string

    Possible values: [created, pending, passing, passed, failing, failed]

    The status of the KYC profile.

    region string

    Region code.

    createdAt string

    Timestamp of KYC profile creation.

    createdBy string

    The Immersve Resource Name (IRN) that created the resource.

    modifiedAt string

    Timestamp of this KYC profile modification.

    modifiedBy string

    The Immersve Resource Name (IRN) that modified the resource.

Loading...