Check account is resident

Checks whether the holder of a given account is a resident natural person (as opposed to a non-resident natural person or a juridical person), for MEP fiscal-residency purposes.

GET/v1/operations/usd-mep/is-resident/{accountNumber}

Request

Headers

Field	Type	Required	Description
Authorization	string	Yes	Access token in Bearer ACCESS_TOKEN format

Path Parameters

Field	Type	Required	Description
accountNumber	integer	Yes	Client account number to check.

Not applicable: Query Parameters, Body.

Response

2XX Success

Raw boolean body

Unlike most endpoints in this API, this endpoint returns a bare JSON boolean as the response body — not a JSON object.

Field	Type	Description
(root)	boolean	true if the account holder is a resident natural person; false otherwise (non-resident natural person or juridical person).

Error Codes

Status	Description
400	Bad Request — accountNumber is invalid
401	Unauthorized — invalid or missing access token
403	Forbidden — the token does not have permission to access this resource
500	Internal Server Error

Error structure:

{
  "code": "BAD_REQUEST",
  "description": "Invalid account number"
}

Code Example

cURL

curl -X GET https://b2b.allaria.dev/v1/operations/usd-mep/is-resident/12345 \
  -H "Authorization: Bearer ACCESS_TOKEN"

JavaScript

const accountNumber = 12345;

const response = await fetch(
  `https://b2b.allaria.dev/v1/operations/usd-mep/is-resident/${accountNumber}`,
  {
    method: 'GET',
    headers: { 'Authorization': 'Bearer ACCESS_TOKEN' }
  }
);
const data = await response.json();
console.log(data);

Python

import requests

account_number = 12345

response = requests.get(
  f'https://b2b.allaria.dev/v1/operations/usd-mep/is-resident/{account_number}',
  headers={ 'Authorization': 'Bearer ACCESS_TOKEN' }
)
data = response.json()
print(data)

Node.js

const axios = require('axios');

const accountNumber = 12345;

const response = await axios.get(
  `https://b2b.allaria.dev/v1/operations/usd-mep/is-resident/${accountNumber}`,
  { headers: { Authorization: 'Bearer ACCESS_TOKEN' } }
);
console.log(response.data);

2XX Success

true