Skip to main content

Retrieve Partner KYC Statement

GET 

/api/accounts/:cardholderAccountId/partner-kyc-statement

Retrieve the KYC statement for the cardholder if it exists.

Request

Path Parameters

    cardholderAccountId stringrequired

    ID of the cardholder account.

    Example: 65a7e8ef0d230d0a6bf755e07d39eb02

Responses

Schema

    accountId string

    The cardholder account id.

    partnerAccountId string

    The partner account id that is affiliated with the cardholder.

    createdAt string

    Timestamp of KYC statement creation.

    createdBy string

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

    idempotencyKey string

    A client-supplied identifier that prevents duplicate creation.

    claims

    object[]

    A list of claims about the cardholder's identity.

  • Array [

  • claimType string

    Possible values: [FULL_NAME, DOB, ADDRESS]

    The type of claim.

    attributes

    object

    The attributes that support the claim.

    oneOf

    givenName string

    Primary name.

    middleName string

    Other name(s).

    familyName string

    Family name or surname.

    honorific string

    Title used to address the cardholder.

  • ]

  • evidence

    object[]

    A list of evidence supporting the claimed identity. At least one piece of evidence is required.

  • Array [

  • anyOf

    evidenceType stringrequired

    Possible values: [PASSPORT]

    The type of evidence.

    documentId stringrequired

    The passport number.

    country stringrequired

    Possible values: [NZL, AUS]

    The country that issued the document.

    expiry stringrequired

    The passport expiry formatted as YYYY-MM-DD.

  • ]

  • region string

    An Alpha3 (ISO-3166-1) country code representing the country in which the user is being verified.

Loading...