Get onboarding invite | Moov Documentation

Get onboarding invite

Retrieve details about an onboarding invite.

To access this endpoint using an access token you'll need to specify the /accounts.read scope.

GET

/onboarding-invites/{code}

Ask

curl -X GET "https://api.moov.io/onboarding-invites/{code}" \
  -H "Authorization: Bearer {token}" \
  -H "X-Moov-Version: v2026.07.00"

Ask

import { Moov } from "@moovio/sdk";

const moov = new Moov({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.onboarding.getInvite({
    code: "N1IA5eWYNh",
  });

console.log(result);
}

run();

Ask

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$response = $sdk->onboarding->getInvite(
    code: 'N1IA5eWYNh'
);

if ($response->onboardingInvite !== null) {
    // handle response
}

Ask

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.GetOnboardingInviteResponse;
import java.lang.Exception;

public class Application {

public static void main(String[] args) throws Exception {

Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

GetOnboardingInviteResponse res = sdk.onboarding().getInvite()
                .code("N1IA5eWYNh")
                .call();

if (res.onboardingInvite().isPresent()) {
            System.out.println(res.onboardingInvite().get());
        }
    }
}

Ask

from moovio_sdk import Moov
from moovio_sdk.models import components

with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

res = moov.onboarding.get_invite(code="N1IA5eWYNh")

# Handle response
    print(res)

Ask

require 'moov_ruby'

Models = ::Moov::Models
s = ::Moov::Client.new(
  security: Models::Components::Security.new(
    username: '',
    password: ''
  )
)
res = s.onboarding.get_invite(code: 'N1IA5eWYNh')

unless res.onboarding_invite.nil?
  # handle response
end

Ask

using Moov.Sdk;
using Moov.Sdk.Models.Components;

var sdk = new MoovClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Onboarding.GetInviteAsync(code: "N1IA5eWYNh");

// handle response

The request completed successfully.

Ask

Example

{
  "code": "N1IA5eWYNh",
  "link": "http://example.com",
  "returnURL": "string",
  "termsOfServiceURL": "string",
  "scopes": [\
    "accounts.read"\\
  ],
  "grantScopes": [\
    "transfers.write"\\
  ],
  "capabilities": [\
    "collect-funds.card-payments",\
    "send-funds.ach"\\
  ],
  "feePlanCodes": [\
    "merchant-direct"\\
  ],
  "redeemedAccountID": "string",
  "prefill": {
    "accountType": "business",
    "profile": {
      "business": {
        "legalBusinessName": "Whole Body Fitness LLC"
      }
    }
  },
  "partner": {
    "accountID": "string",
    "accountMode": "production",
    "displayName": "Bob's Widgets"
  },
  "createdOn": "2019-08-24T14:15:22Z",
  "revokedOn": "2019-08-24T14:15:22Z",
  "redeemedOn": "2019-08-24T14:15:22Z"
}