Skip to content
On this page

Partner: Auth API

EndpointMethodDescription
/api/v0/partnerRpc/auth.registerUserjsonRpcRegister user
/api/v0/partnerRpc/auth.getUserByEmailAndPasswordjsonRpcGet user by email and password

Register user

Method: jsonRpc

HTTP Method: POST

Path: /api/v0/partnerRpc/auth.registerUser

Request:

{
    "email": string
    "password": string
    "firstName": string
    "lastName": string
}

Response:

{
    "data": {
        "userId": string
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get user by email and password

Method: jsonRpc

HTTP Method: POST

Path: /api/v0/partnerRpc/auth.getUserByEmailAndPassword

Request:

{
    "email": string
    "password": string
}

Response:

{
    "data": {
        "user": {
            "id": string
            "created": timestamp
            "updated": timestamp
            "companyName": string  // name of company that user represents
            "companyTitle": string  // user title in the company
            "firstName": string
            "lastName": string
            "birthday": string
            "hometown": string
            "education": string
            "zipCode": string
            "description": string
            "linkUrl": string
            "privacyMode": int  // 0 - Default, 1 - Incognito
            "avatar": string  // url or resource id
            "avatar3D": {  // asset of user 3D avatar
                "assetId": string
                "assetSkins": map[string]string  // map of selected skins per variants
                "avatarUrl": string  // url to gbl file (Ready Player Me)
                "avatarUserId": string  // user id for session recovery (Ready Player Me)
            }
            "params": map[string]{ custom structure }  // custom user parameters, for example link to Zoom conference
            "identityType": int  // 0 - Not Assigned, 1 - SSID, 2 - VSSID
            "identityName": string  // Verus identity name
            "zAddress": string  // z-address of user, generated by client application using Verus scoped root key
            "publicRoomCount": int
            "contactCount": int
            "pendingContactCount": int
            "newInvitationsCount": int
            "pendingRequestCount": int
            "newNotificationsCount": int
            "idealMatchCount": int
            "isDisabled": bool
            "isNew": bool
            "email": string
            "emailVerified": bool
            "phoneNumber": string
        }
    }
    "error": { "status": bool, "code": int, "message": string }
}