Skip to main content
GET
/
v2.01
/
{ClientId}
/
users
/
{UserId}
/
regulatory
const mangopayInstance = require('mangopay2-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

let user = {
  Id: '146476890',
}

const getRegulatoryStatus = async (userId) => {
  return await mangopay.Users.getRegulatory(userId)
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

getRegulatoryStatus(user.Id)  

{
    "ActionCode": "008701",
    "ScopeBlocked": {
        "Inflows": true,
        "Outflows": false
    },
    "Id": "146476890"
}

​
Path parameters

​
UserId
string
required
The unique identifier of the user.

​
Responses

200

​
ActionCode
string
Returned values: One of the action codes available in the Blocked users article.Code indicating the reason for blocking the user, and steps you can take to get them unblocked.
​
ScopeBlocked
object
Information about which payment flows are blocked for the user.
​
Id
string
The unique identifier of the user.
{
    "ActionCode": "008701",
    "ScopeBlocked": {
        "Inflows": true,
        "Outflows": false
    },
    "Id": "146476890"
}  

const mangopayInstance = require('mangopay2-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

let user = {
  Id: '146476890',
}

const getRegulatoryStatus = async (userId) => {
  return await mangopay.Users.getRegulatory(userId)
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

getRegulatoryStatus(user.Id)
⌘I