Skip to main content
POST
/
3p
/
api
/
v2
/
users
Onboard a new Person into the ACH application ( SUNSETTING )
curl --request POST \
  --url https://api.grailpay.com/3p/api/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_reference_id": "123456",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone": "1234567890",
  "address": {
    "line_1": "10554 W Quarles Ave",
    "city": "Littleton",
    "state": "CO",
    "zip": "80127"
  },
  "bank_account": {
    "custom": {
      "account_number": "123456789",
      "routing_number": "123456789",
      "account_name": "John Doe",
      "account_type": "checking"
    }
  },
  "billing_merchant_user_uuid": "2bcf2ac3-38fc-4238-a638-4f092821fc27",
  "billing_processor_mid": "21245678932",
  "payout_type": "individual"
}
'
{
  "status": true,
  "message": "<string>",
  "data": {
    "client_reference_id": "company_45458",
    "uuid": "9d264b4a-006c-4d01-acd0-730e27784c59",
    "first_name": "John",
    "last_name": "Dew",
    "email": "[email protected]",
    "phone": "2457856490",
    "user_status": "APPROVED",
    "payout_type": "individual",
    "address": {
      "street_address": "10554 W Quarles Ave",
      "city": "Littleton",
      "state": "CO",
      "country": "US",
      "zip": "80127"
    },
    "role": "Person",
    "vendor_name": "Fintech",
    "valid_account": "Valid",
    "bank_account": {
      "risk": {
        "confidence_score": "0.83",
        "threshold": "0.61"
      }
    },
    "created_at": "2024-10-02 14:06:14",
    "updated_at": "2024-10-02 14:06:17"
  },
  "errors": {},
  "error_code": "<string>"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication using Authorization: Bearer <YOUR_API_KEY> provided by the GrailPay Support Team.

Body

application/json
​
client_reference_id
string | null
Example:

"123456"

​
first_name
string | null
Example:

"John"

​
last_name
string | null
Example:

"Doe"

​
email
string | null
​
phone
string | null
Example:

"1234567890"

​
address
object
​
bank_account
object

Bank account can be either Plaid or Custom, not both

​
billing_merchant_user_uuid
string<uuid> | null
Example:

"2bcf2ac3-38fc-4238-a638-4f092821fc27"

​
billing_processor_mid
string | null
Example:

"21245678932"

​
payout_type
enum<string> | null
Available options:
batch,
individual
Example:

"individual"

Response

Person registered successfully

Schema for a person response

​
status
boolean

Response status

Example:

true

​
message
string

Response message

​
data
object

User data

​
errors
object

Error details if any

​
error_code
string | null

Error code if any