Skip to main content
Get create account URL
curl --request POST \
  --url https://api.example.com/client-interfaces/pmo/get-create-account-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "PersonalData": {
    "FirstName": "<string>",
    "LastName": "<string>",
    "Gender": "<string>",
    "BirthDate": "<string>",
    "Address": {
      "Address1": "<string>",
      "ZipCode": "<string>",
      "City": "<string>",
      "CountryCode": "<string>",
      "StateCode": "<string>",
      "Address2": "<string>"
    },
    "PhoneNumber": "<string>",
    "Email": "<string>",
    "MiddleName": "<string>",
    "LastName2": "<string>"
  },
  "PersonalDocuments": [
    {
      "Number": "<string>"
    }
  ]
}
'
{
  "RegistrationUrl": "<string>",
  "Success": true,
  "ResponseDescription": "<string>"
}
This API MUST be implemented by the Partner. Platform’s backend will consume it to obtain the delegated registration link.
Our backend will consume this service by performing a POST request to: [Base-URL]/GetCreateAccountUrl. This endpoint will only be used when the Partner has account creation configured as OnDemand. Expected behavior: Invokes the retrieval of a temporary delegated registration URL. In cases where the Partner orchestrates the user account registration, this endpoint must generate and return a secure RegistrationUrl where the user can complete or initiate their enrollment.

Body

application/json
PersonalData
object
required

Personal information. At least one of PhoneNumber or Email must be provided.

PersonalDocuments
object[]

Response

200 - application/json

Ok

RegistrationUrl
string
required
Success
boolean
required
ResponseDescription
string
required