Sign Up

Use the API for Advertiser and Partner User signups.

The Everflow platform offers a way for new Users to sign up in the UI. However, some organizations prefer hosting the signup page on their own website and submit the result to Everflow via the API.

The endpoints described here will help you achieve that.

The payloads submitted will mimic what a user would enter when using the signup form available on Everflow which is documented here.

New Users must have an email address that is unique among all users of the same “type” (Two Partner Users cannot have the same email address, but a Partner User can have the same email address as an Advertiser User).

Note that the content of the payload will be validated. For example, the address submitted must have a valid country, etc.

Custom signup fields (which are optional and defined in Control Center > Configuration > UI Customization), can be used to submit custom signup data on this endpoint. If they are marked as mandatory in Everflow, signups submitted via the API that do not contain the mandatory custom fields will result in an error.


Partner Signup

POST /v1/networks/affiliate/signup

If custom fields are used, their unique ID can be found by doing a GET on /v1/networks/settings/affiliateportal. The unique ID needed will be located in the relationship.custom_fields property of the response.

If the option is enabled at the network level, billing details can also be passed during the signup.

Signup links on Everflow can contain embedded information about:

  • The Partner Manager that will be responsible for the new Partner account
  • The Partner that referred New Partner

These values are encoded in the link. If used they must be submitted the same way in the payload as shown in the second example below. You can use the Encode / Decode endpoints to extract the numeric values if needed.

Note that you can determine which fields are required / optional for your account. Visit Control Center > Configuration > UI Customization > Partner Signup to manage the settings.

firstname string

The first name of the affiliate user signing up

lastname string

The last name of the affiliate user signing up

email string

The email address of the user signing up. Must be unique

phone string

Phone number

legal_type string

The affiliate’s entity legal type. Can be one of the following values: individual, partnership, corporation, sole_proprietorship, other, foreign, llc, llp, non_profit, non_us_entity.

company string

The affiliate’s company name. Will become the name property once / if the affiliate is approved.

website string

The affiliate’s website

advertise_method_description string

Method used by the affiliate to advertise

custom_terms string

Network defined custom terms and conditions that the affiliate accepted.

platform_terms string

Everflow’s terms and conditions that the affiliate accepted.

contact_address object

The affiliate’s contact address information. Only required if “is_contact_address_enabled” is set to true.

address_1 string

The address first line

address_2 string

The address second line

city string

The city name

region_code string

The region code. Can be found using the metadata API.

country_code string

The country code. Can be found using the metadata API.

zip_postal_code string

The ZIP or Postal code.

referral_code string

Referral code used by the affiliate

tax_id string

Affiliate’s tax ID (used for billing)

affiliate_manager_encoded_value string

Affiliate manager’s encoded ID

referrer_encoded_value string

Encoded value of the affiliate ID that referred the new sign up

billing object

The affiliate’s billing information.

payment_type string

The affiliate’s payment type. Can be one of the following values: none, paypal, check, wire, direct_deposit, tipalti, payum, veem, payoneer, bitcoin, webmoney, capitalist, gift_card, masspay or skrill

billing object

The affiliate’s payment method details. Required when “payment_type” is set to anything else than “none”.

paxum_id string

The affiliate’s paxum id. Required when “payment_type” is set to “paxum”.

paypal_reception_method string

The reception method used with Paypal. Can be either “email”, “phone” or “paypal_account”. Required when “payment_type” is set to “paypal”.

reception_identifier string

The affiliate’s paypal reception identifier. Required when “payment_type” is set to “paypal”.

email string

The affiliate’s email. Required when “payment_type” is set to “payoneer” or “veem”.

is_existing_payee boolean

Whether you want to assign an existing payee id to this affiliate. Required when “payment_type” is set to “tipalti”.

idap string

The payee’s IDAP (Payee ID). Required when “payment_type” is set to “tipalti” and is_existing_payee is set to true.

first_name string

The affiliate’s first name. Required when “payment_type” is set to “veem”.

last_name string

The affiliate’s last name. Required when “payment_type” is set to “veem”.

phone string

The affiliate’s phone number, must be international format. Required when “payment_type” is set to “veem”.

country_iso string

The affiliate’s country ISO code. Required when “payment_type” is set to “veem”.

bank_name string

The affiliate’s bank name. Required when “payment_type” is set to “wire” or “direct_deposit”.

bank_address string

The affiliate’s bank address. Required when “payment_type” is set to “wire” or “direct_deposit”.

account_name string

The affiliate’s bank account name. Required when “payment_type” is set to “wire” or “direct_deposit”.

account_number string

The affiliate’s bank account number. Required when “payment_type” is set to “wire” or “direct_deposit”.

routing_number string

The affiliate’s bank routing number. Required when “payment_type” is set to “wire” or “direct_deposit”.

swift_code string

The affiliate’s swift code. Required when “payment_type” is set to “wire” or “direct_deposit”.

cURL
curl --request POST 'https://api.eflow.team/v1/networks/affiliate/signup' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
--data '<INSERT PAYLOAD>'

Request

A basic signup request would look like this:

{
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@example.com",
    "phone": "555-555-1212",
    "legal_type": "individual",
    "company": "Example company",
    "website": "http://example-website.com",
    "advertise_method_description": "Facebook, Google Ads",
    "custom_terms": "<The custom terms and conditions the user agrees to>",
    "platform_terms": "<The platform terms and conditions the user agrees to>",
    "contact_address": {
        "address_1": "Address Line 1",
        "address_2": "Address Line 2",
        "city": "Example City",
        "zip_postal_code": "32789",
        "country_id": 227,
        "region_code": "FL"
    }
}

A more complete request could look like this:

{
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@example.com",
    "phone": "555-555-1212",
    "legal_type": "individual",
    "company": "Example company",
    "website": "http://example-website.com",
    "advertise_method_description": "Facebook, Google Ads",
    "custom_terms": "<The custom terms and conditions the user agrees to>",
    "platform_terms": "<The platform terms and conditions the user agrees to>",
    "contact_address": {
        "address_1": "Address Line 1",
        "address_2": "Address Line 2",
        "city": "Example City",
        "zip_postal_code": "32789",
        "country_id": 227,
        "region_code": "FL"
    },
    "referral_code": "facebook",
    "tax_id" : "...",
    "billing":
    {
        "payment_type": "paypal",
        "billing":
        {
            "paypal_reception_method": "paypal_account",
            "reception_identifier": "user@example.com"
        }
    },
    "custom_field_values": [
        {
            "network_signup_custom_field_id": 2,
            "field_value": "my optional custom field value"
        },
        {
            "network_signup_custom_field_id": 11,
            "field_value": "my optional custom field value"
        },
        {
            "network_signup_custom_field_id": 16,
            "field_value": "my optional custom field value"
        },
    ],
    "affiliate_manager_encoded_value": "RNK3G2",
    "referrer_encoded_value": "RNK3G2"
}

Advertiser Signup

POST /v1/networks/advertiser/signup

If custom fields are used, their unique ID can be found by doing a GET on /v1/networks/settings/advertiserportal. The unique ID needed will be located in the relationship.custom_fields property of the response.

cURL
curl --request POST 'https://api.eflow.team/v1/networks/advertiser/signup' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
--data '<INSERT PAYLOAD>'

Request

A signup request could look like this:

{
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@example.com",
    "phone": "555-555-1212",
    "company": "Example company",
    "website": "http://example-website.com",
    "offer_landing_page": "example landing page",
    "custom_terms": "<The custom terms and conditions the user agrees to>",
    "platform_terms": "<The platform terms and conditions the user agrees to",
    "referral_code": "facebook",
    "is_agree_platform_term": true,
    "contact_address": {
        "address_1": "Address Line 1",
        "address_2": "Address Line 2",
        "city": "Example City",
        "zip_postal_code": "32789",
        "country_id": 227,
        "region_code": "FL"
    },
    "custom_field_values": [
        {
            "network_signup_custom_field_id": 2,
            "field_value": "my optional custom field value"
        },
        {
            "network_signup_custom_field_id": 11,
            "field_value": "my optional custom field value"
        },
        {
            "network_signup_custom_field_id": 16,
            "field_value": "my optional custom field value"
        },
    ]
}