COcoinify

Initiate identification attempt

Changed on

Initiates an identification attempt. The user must be redirected to the URL specified in the redirectUrl parameter of the response in order to actually identify themselves.

post/kyc/identification-attempts

Request

  • Base URL
    https://app-api.sandbox.coinify.com
  • URL
    https://app-api.sandbox.coinify.com/kyc/identification-attempts
  • Auth
    none required

Headers

Authorizationstring required

Must contain Bearer <access_token> value as received upon Authentication.

Request body

returnUrlstring required

(URL) URL to return the end-user to after the KYC process is done, when using the KYC redirectUrl from the response. See Returning after identification flow for more information.

deviceTypestring

Type of device on which the user will perform identification. Used to provide the best possible user experience. Possible values are android (Android phone/tablet), ios (iPhone/iPad), desktop (Non-mobile device). If left blank, auto-detection will be attempted from the User-Agent HTTP header of the request.

Response

200

idstring
statestring
createTimestring
approveTimeunknown
expireTimeunknown
redirectUrlstring
returnUrlstring
sdkTokenunknown

Example response

{
  "id": "0cf12488-0dcf-4f99-96c4-e1ec879c906d",
  "state": "pending",
  "createTime": "2019-11-26T07:45:44.852Z",
  "redirectUrl": "https://www.example.com/redirect-client-to-this-url",
  "returnUrl": "https://mypage.com/ida_complete"
}

Changes