List all verifications for a user

curl --request GET \
  --url https://int-api.mx.com/users/{user_guid}/account_verifications \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_guid}/account_verifications"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_guid}/account_verifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/users/{user_guid}/account_verifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/users/{user_guid}/account_verifications"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-api.mx.com/users/{user_guid}/account_verifications")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/account_verifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "account_verifications": [
    {
      "account_name": "Test account 2",
      "account_number": "5366",
      "account_number_guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
      "account_type": "SAVINGS",
      "created_at": "2016-10-13T17:57:37.000Z",
      "institution_code": "chase",
      "institution_name": "Chase Bank",
      "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
      "micro_deposit_guid": "MCD-7ed79542-884d-2b1b-dd74-501c5cc9d25b",
      "routing_number": "68899990000000",
      "updated_at": "2023-06-13T17:57:37.000Z",
      "verification_method": "MICRO_DEPOSIT",
      "verified_at": "2023-06-13T17:57:37.000Z"
    }
  ]
}

GET

users

{user_guid}

account_verifications

List all verifications for a user

curl --request GET \
  --url https://int-api.mx.com/users/{user_guid}/account_verifications \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_guid}/account_verifications"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_guid}/account_verifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/users/{user_guid}/account_verifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/users/{user_guid}/account_verifications"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-api.mx.com/users/{user_guid}/account_verifications")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/account_verifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "account_verifications": [
    {
      "account_name": "Test account 2",
      "account_number": "5366",
      "account_number_guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
      "account_type": "SAVINGS",
      "created_at": "2016-10-13T17:57:37.000Z",
      "institution_code": "chase",
      "institution_name": "Chase Bank",
      "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
      "micro_deposit_guid": "MCD-7ed79542-884d-2b1b-dd74-501c5cc9d25b",
      "routing_number": "68899990000000",
      "updated_at": "2023-06-13T17:57:37.000Z",
      "verification_method": "MICRO_DEPOSIT",
      "verified_at": "2023-06-13T17:57:37.000Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

To authenticate with the Platform API, include your Base64-encoded client_id and api_key in the Authorization header of every request:

-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Headers

Accept-Version

string

default:v20260929

required

MX Platform API version.

Example:

"v20260929"

Path Parameters

user_guid

string

required

The unique identifier for a user, beginning with the prefix USR-.

Response

200 - application/json

account_verifications

object[]

required

Hide child attributes

account_verifications.account_name

string

required

The name of the account associated with the verification.

Example:

"Test account 2"

account_verifications.account_number

string

required

The account number of the account associated with the verification.

Example:

"5366"

account_verifications.account_number_guid

string | null

required

The unique identifier for the account associated with the verification. Defined by MX.

Example:

"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1"

account_verifications.account_type

string

required

The name of the account type.

Example:

"SAVINGS"

account_verifications.created_at

string

required

The date and time the verification was created, given in ISO 8601 format.

Example:

"2016-10-13T17:57:37.000Z"

account_verifications.institution_code

string | null

required

The code for the institution associated with the verification. May be null for institutions which are not in the MX system.

Example:

"chase"

account_verifications.institution_name

string | null

required

An easy-to-read name for the institution. May be null for institutions which are not in the MX system.

Example:

"Chase Bank"

account_verifications.member_guid

string | null

required

The unique identifier for the member associated with the verification. Defined by MX. null for microdeposit verifications, which belong to the user.

Example:

"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"

account_verifications.micro_deposit_guid

string | null

required

The unique identifier for the microdeposit associated with the verification. Defined by MX. null when verified by credentials.

Example:

"MCD-7ed79542-884d-2b1b-dd74-501c5cc9d25b"

account_verifications.routing_number

string | null

required

The routing number for the account associated with the verification.

Example:

"68899990000000"

account_verifications.updated_at

string

required

The date and time the verification was last updated, given in ISO 8601 format.

Example:

"2023-06-13T17:57:37.000Z"

account_verifications.verification_method

string

required

The name of the verification method.

Example:

"MICRO_DEPOSIT"

account_verifications.verified_at

string | null

required

When verification_method is CREDENTIALS: when the associated account was created. When MICRO_DEPOSIT: when the microdeposit status changed from DEPOSITED to VERIFIED.

Example:

"2023-06-13T17:57:37.000Z"