Skip to main content
POST
/
auth
/
sessionlink-v2
Get session link
curl --request POST \
  --url https://raas-partner-cv.nomas.cash/v1/auth/sessionlink-v2 \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "phoneNumber": "+5215521206706",
  "firstName": "Maria",
  "lastName": "Garcia",
  "dob": "1987-06-24",
  "city": "San Pedro de los Pinos",
  "zipCode": "03800",
  "state": "CDMX",
  "address3": "Ciudad de México",
  "countryCode": "MX",
  "address1": "Avenida Calle Dos 296",
  "latitude": 19.3953755,
  "longitude": -99.1384059,
  "gender": "Male",
  "email": "ariel+fielContigo@leapfinancial.com",
  "lang": "en",
  "birthState": "MX-CMX",
  "paymentMethodType": "Card",
  "addCardParams": {
    "nameOnCard": "Juan Perez Gomez",
    "cardtype": "DebitCard",
    "expirationDate": "1128",
    "cardNetwork": "Visa",
    "name": "VISA-1111",
    "number": "tok_sandbox_9PNgfqqpdpyQpnD1jYkdw1_1111"
  }
}
'
{
  "paymentMethodStatus": "ValidCard",
  "link": "https://links-dev.nomas.cash/Q1nO3",
  "status": "Completed",
  "statusDetail": "None"
}

Authorizations

​
api_key
string
header
required

Body

application/json

Payload with payment data, amounts, fees and base KYC.

Extends RegisterUserParams for session-link flows that may collect a payment method type and optional UBN or card payloads in the same request.

​
lastName
string
required

Primary legal last name (e.g. paternal surname). Example: Hernández.

​
firstName
string
required

Legal first name(s). Example: Ana.

​
address1
string
required

User legal address, Street and number. Example: Blvd. Kukulcan Km. 4.5.

Strongly recommended to avoid OFAC matches.

​
countryCode
string
required

Country code. ISO 3166-1 alpha-2.

​
city
string
required
​
state
string
required

Address state/province/department. ISO 3166-2:CC (CC: country code). Or the state short name. Example: DF for Distrito Federal, JA for Jalisco.

​
phoneNumber
string

required

Mobile phone number with country code. Must be a valid mobile phone number. Example: +5215521206703 for MX.

It doesn't allow duplicates.

​
lastName2
string

Optional second last name when used (e.g. maternal surname). Example: Gómez.

Strongly recommended to avoid OFAC matches.

​
gender
enum<string>

Self-reported gender when the product collects it. Example: Female.

Available options:
Male,
Female,
Other,
None
​
dob
string<date-time>

Date of birth in ISO 8601 format (YYYY-MM-DD or full date-time). DOB must be a real calendar date and the person must be at least 18 and under 100 years old.

Strongly recommended to avoid OFAC matches.

​
email
string

Email address. It doesn't allow duplicates.

Strongly recommended.

​
middleName
string

Middle name when collected. Example: María. Strongly recommended to avoid OFAC matches.

​
address2
string
​
address3
string
​
streetNumber
string
​
zipCode
string
​
birthState
string

Address state/province/department. ISO 3166-2:CC (CC: country code). Or the state short name. Example: DF for Distrito Federal, JA for Jalisco.

​
lang
enum<string>

User Language. ISO 639-1. Example: es for Spanish, en for English.

Available options:
en,
es
​
placeDetail
string

Place detail from address if available. Must be a valid place detail json from google maps.

​
latitude
number<double>

Latitude from address if available.

​
longitude
number<double>

Longitude from address if available.

​
callLocationLatitude
number<double>

Latitude from user location if available.

​
callLocationLongitude
number<double>

Longitude from user location if available.

​
paymentMethodType
enum<string>

How the user will add a funding instrument in the widget flow, when applicable.

Available options:
BankAccount,
DigitalWallet,
Card,
UBN
​
ubnParams
object

Optional UBN payload when paymentMethodType is UBN.

​
addCardParams
object

Proper method for adding cards as payment method

Response

Response when a session link is created for onboarding or upgrade (sessionlink-* routes).

​
link
string
required

HTTPS URL the end user should open to continue onboarding in the widget.

​
status
string

High-level user or flow status string (product-specific).

​
statusDetail
enum<string>

Structured status detail from the CIP / account platform when provided.

Available options:
None,
InvalidAddress,
InvalidEMail,
UnreadableDoc,
ProvideAdditionalInfo,
InvalidPersonalData,
OtpPrivacyMissing,
OtpContractMissing,
Compliance,
ComplianceBlocked,
OfacFailed
​
cipStatus
string

CIP pipeline status label when applicable.

​
cipStatusDetail
enum<string>

Structured CIP detail when provided.

Available options:
None,
InvalidAddress,
InvalidEMail,
UnreadableDoc,
ProvideAdditionalInfo,
InvalidPersonalData,
OtpPrivacyMissing,
OtpContractMissing,
Compliance,
ComplianceBlocked,
OfacFailed
​
accountStatus
string

Account lifecycle status when returned by the platform.

​
paymentMethodStatus
string

Funding instrument readiness when returned by the platform.

​
userId
string

Internal user id once the user record exists.