Get KYC Status

GET 
/profile/kyc/status

Retrieves the KYC status of the user.

Responses

200

OK

application/json

Schema

Schema

customerId stringrequired

Merchant's Paysafe wallet customer id

externalId ExternalId (string)required

Possible values: non-empty and <= 40 characters

Customer identifier used in Partner system.

kycVerificationStatus KycVerificationStatus (string)required

Possible values: [INCOMPLETE, IN_PROGRESS, COMPLETED]

Default value: INCOMPLETE

COMPLETED - Customer is verified successfully.
IN_PROGRESS - Customer verification is in progress. The verification results are not ready or additional manual verification process is in progress.
INCOMPLETE - Customer is not verified.

Example (from schema)

{
  "customerId": "string",
  "externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
  "kycVerificationStatus": "COMPLETED"
}

VERIFICATION_STATUS_COMPLETED

{
  "customerId": "4214213213",
  "externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
  "kycVerificationStatus": "COMPLETED"
}

VERIFICATION_STATUS_IN_PROGRESS

{
  "customerId": "4214213213",
  "externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
  "kycVerificationStatus": "IN_PROGRESS"
}

VERIFICATION_STATUS_INCOMPLETE

{
  "customerId": "4214213213",
  "externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
  "kycVerificationStatus": "INCOMPLETE"
}

500

Internal Server Error

application/json

Schema

Schema

error

object

Additional details about an error

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

Loading...