Skip to main content

Onboard a user device

POST 
/api/gateway/v1/mpass/users/:userId/devices/:requestId/code

Onboard a user device with qr code generated from gateway API, which doesn't require user to submit verfication code on UI

Request​

Path Parameters

    userId stringrequired

    User ID

    requestId stringrequired

    Onboarding request ID

Body

required

    deviceName stringrequired

    Device name

    deviceToken stringrequired

    Device token

    publicKey stringrequired

    Device public key

Responses​

Device onboarded successfully

Schema

    status numberrequired

    Response status code

    message stringrequired

    Response status message

    data

    object

    required

    Response data

    userId stringrequired

    User ID

    deviceId stringrequired

    Device ID

    status stringrequired

    Possible values: [active, inactive]

    Device status

    userCode stringrequired

    User code

    deviceCode stringrequired

    Device code

    tokenEndpoint stringrequired

    Token endpoint, mobile app will poll this endpoint to get the token

    interval numberrequired

    Interval, mobile app will poll the token endpoint every interval milliseconds

    requestId string

    Request ID for tracking

Loading...