VerificationApi.md

\VerificationApi

Method	HTTP request	Description
ListAccountNumbers	Get /users/{user_guid}/members/{member_guid}/account_numbers	Read account numbers
ListAccountNumbersByAccount	Get /users/{user_guid}/accounts/{account_guid}/account_numbers	Read account numbers by account GUID
VerifyMember	Post /users/{user_guid}/members/{member_guid}/verify	Verify

ListAccountNumbers

AccountNumbersResponseBody ListAccountNumbers(ctx, memberGUID, userGUID) Read account numbers

Use this endpoint to check whether account and routing numbers are available for accounts associated with a particular member. It returns the account_numbers object, which contains account and routing number data for each account associated with the member.

Example

package main

import (
  "context"
  "fmt"
  "github.com/mxenabled/atrium-go"
)

func main() {
  client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
  ctx := context.Background()
  
  memberGUID := "MBR-123" // string | The unique identifier for a `member`.
  userGUID := "USR-123" // string | The unique identifier for a `user`.

  response, _, err := client.Verification.ListAccountNumbers(ctx, memberGUID, userGUID, )
  if err != nil {
    fmt.Printf("Error: %v\n", err)
  } else {
    fmt.Printf("Response: %s\n", response)
  }
}

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
memberGUID	string	The unique identifier for a `member`.
userGUID	string	The unique identifier for a `user`.

Return type

AccountNumbersResponseBody

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAccountNumbersByAccount

AccountNumbersResponseBody ListAccountNumbersByAccount(ctx, accountGUID, userGUID) Read account numbers by account GUID

Use this endpoint to check whether account and routing numbers are available for a specific account. It returns the account_numbers object, which contains account and routing number data.

Example

package main

import (
  "context"
  "fmt"
  "github.com/mxenabled/atrium-go"
)

func main() {
  client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
  ctx := context.Background()
  
  accountGUID := "ACT-123" // string | The unique identifier for an `account`.
  userGUID := "USR-123" // string | The unique identifier for a `user`.

  response, _, err := client.Verification.ListAccountNumbersByAccount(ctx, accountGUID, userGUID, )
  if err != nil {
    fmt.Printf("Error: %v\n", err)
  } else {
    fmt.Printf("Response: %s\n", response)
  }
}

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountGUID	string	The unique identifier for an `account`.
userGUID	string	The unique identifier for a `user`.

Return type

AccountNumbersResponseBody

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VerifyMember

MemberResponseBody VerifyMember(ctx, memberGUID, userGUID) Verify

The verify endpoint begins a verification process for a member.

Example

package main

import (
  "context"
  "fmt"
  "github.com/mxenabled/atrium-go"
)

func main() {
  client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
  ctx := context.Background()
  
  memberGUID := "MBR-123" // string | The unique identifier for a `member`.
  userGUID := "USR-123" // string | The unique identifier for a `user`.

  response, _, err := client.Verification.VerifyMember(ctx, memberGUID, userGUID, )
  if err != nil {
    fmt.Printf("Error: %v\n", err)
  } else {
    fmt.Printf("Response: %s\n", response)
  }
}

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
memberGUID	string	The unique identifier for a `member`.
userGUID	string	The unique identifier for a `user`.

Return type

MemberResponseBody

[Back to top] [Back to API list] [Back to Model list] [Back to README]